diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/privatelink/2020-04-15 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/privatelink/2020-04-15')
| -rw-r--r-- | data/en_us/privatelink/2020-04-15/api-docs.php | 8778 |
1 files changed, 8778 insertions, 0 deletions
diff --git a/data/en_us/privatelink/2020-04-15/api-docs.php b/data/en_us/privatelink/2020-04-15/api-docs.php new file mode 100644 index 0000000..cfe264d --- /dev/null +++ b/data/en_us/privatelink/2020-04-15/api-docs.php @@ -0,0 +1,8778 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Privatelink', + 'version' => '2020-04-15', + ], + 'directories' => [ + [ + 'id' => 176808, + 'title' => 'PrivateLink', + 'type' => 'directory', + 'children' => [ + 'OpenPrivateLinkService', + 'CheckProductOpen', + ], + ], + [ + 'id' => 176765, + 'title' => 'Regions and zones', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + 'DescribeZones', + ], + ], + [ + 'id' => 3189, + 'title' => 'Endpoint services', + 'type' => 'directory', + 'children' => [ + 'CreateVpcEndpointService', + 'UpdateVpcEndpointServiceAttribute', + 'GetVpcEndpointServiceAttribute', + 'ListVpcEndpointServices', + 'DeleteVpcEndpointService', + ], + ], + [ + 'id' => 3191, + 'title' => 'Service whitelists', + 'type' => 'directory', + 'children' => [ + 'AddUserToVpcEndpointService', + 'ListVpcEndpointServiceUsers', + 'RemoveUserFromVpcEndpointService', + ], + ], + [ + 'id' => 3194, + 'title' => 'Service resources', + 'type' => 'directory', + 'children' => [ + 'UpdateVpcEndpointServiceResourceAttribute', + 'AttachResourceToVpcEndpointService', + 'ListVpcEndpointServiceResources', + 'DetachResourceFromVpcEndpointService', + ], + ], + [ + 'id' => 3198, + 'title' => 'Endpoints', + 'type' => 'directory', + 'children' => [ + 'DeleteVpcEndpoint', + 'CreateVpcEndpoint', + 'UpdateVpcEndpointAttribute', + 'ListVpcEndpoints', + 'GetVpcEndpointAttribute', + 'ListVpcEndpointServicesByEndUser', + ], + ], + [ + 'id' => 3203, + 'title' => 'Endpoint connections', + 'type' => 'directory', + 'children' => [ + 'EnableVpcEndpointConnection', + 'UpdateVpcEndpointConnectionAttribute', + 'ListVpcEndpointConnections', + 'DisableVpcEndpointConnection', + ], + ], + [ + 'id' => 3207, + 'title' => 'Endpoint zones', + 'type' => 'directory', + 'children' => [ + 'AddZoneToVpcEndpoint', + 'ListVpcEndpointZones', + 'RemoveZoneFromVpcEndpoint', + ], + ], + [ + 'id' => 176753, + 'title' => 'Endpoint zone connections', + 'type' => 'directory', + 'children' => [ + 'DisableVpcEndpointZoneConnection', + 'EnableVpcEndpointZoneConnection', + 'UpdateVpcEndpointZoneConnectionResourceAttribute', + ], + ], + [ + 'id' => 3212, + 'title' => 'Security groups', + 'type' => 'directory', + 'children' => [ + 'AttachSecurityGroupToVpcEndpoint', + 'ListVpcEndpointSecurityGroups', + 'DetachSecurityGroupFromVpcEndpoint', + ], + ], + [ + 'id' => 176748, + 'title' => 'Tags & Resource group', + 'type' => 'directory', + 'children' => [ + 'UntagResources', + 'ListTagResources', + 'TagResources', + 'ChangeResourceGroup', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'OpenPrivateLinkService' => [ + 'summary' => 'Activates PrivateLink.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkWPBSZV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '3245****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountTypeRestricted', + 'errorMessage' => 'Please submit the application for beta testing first. You can activate the product after the application is approved.', + ], + [ + 'errorCode' => 'OrderOpend', + 'errorMessage' => 'You have already activated the service. Go to the console to start using it.', + ], + [ + 'errorCode' => 'InvalidAccountStatus.NotEnoughBalance', + 'errorMessage' => 'Your account does not have enough balance.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D\\",\\n \\"OrderId\\": \\"3245****\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenPrivateLinkServiceResponse>\\n <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>\\n <OrderId>3245****</OrderId>\\n</OpenPrivateLinkServiceResponse>","errorExample":""}]', + 'title' => 'OpenPrivateLinkService', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckProductOpen' => [ + 'summary' => 'Queries whether PrivateLink is activated.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelink7YBDSO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + 'Success' => [ + 'description' => 'Indicates whether PrivateLink is activated.'."\n" + ."\n" + .'Only **true** is returned. The value indicates that PrivateLink is activated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => 'The returned results.'."\n", + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NeedOpenProduct', + 'errorMessage' => 'The product is not activated.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CheckProductOpenResponse>\\n <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>\\n <Success>true</Success>\\n</CheckProductOpenResponse>","errorExample":""}]', + 'title' => 'CheckProductOpen', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries available regions and zones.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkX3ZDB5', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The available regions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China (Hangzhou)'."\n", + ], + 'RegionEndpoint' => [ + 'description' => 'The endpoint of the region.'."\n", + 'type' => 'string', + 'example' => 'privatelink.cn-hangzhou.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ServiceResourceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServiceResourceType' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionEndpoint\\": \\"privatelink.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ServiceResourceTypes\\": {\\n \\"ServiceResourceType\\": [\\n \\"slb\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>A355E857-97F5-5054-9AC8-BCE064939652</RequestId>\\n <Regions>\\n <Region>\\n <RegionId>cn-hangzhou</RegionId>\\n <RegionEndpoint>privatelink.cn-hangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东1（杭州）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shanghai</RegionId>\\n <RegionEndpoint>privatelink.cn-shanghai.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东2（上海）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-nanjing</RegionId>\\n <RegionEndpoint>privatelink.cn-nanjing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华东5（南京-本地地域）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-qingdao</RegionId>\\n <RegionEndpoint>privatelink.cn-qingdao.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北1（青岛）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-beijing</RegionId>\\n <RegionEndpoint>privatelink.cn-beijing.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北2（北京）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <RegionEndpoint>privatelink.cn-zhangjiakou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北3（张家口）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-huhehaote</RegionId>\\n <RegionEndpoint>privatelink.cn-huhehaote.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北5（呼和浩特）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-wulanchabu</RegionId>\\n <RegionEndpoint>privatelink.cn-wulanchabu.aliyuncs.com</RegionEndpoint>\\n <LocalName>华北6（乌兰察布）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-shenzhen</RegionId>\\n <RegionEndpoint>privatelink.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-heyuan</RegionId>\\n <RegionEndpoint>privatelink.cn-heyuan.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南2（河源）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-guangzhou</RegionId>\\n <RegionEndpoint>privatelink.cn-guangzhou.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南3（广州）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-chengdu</RegionId>\\n <RegionEndpoint>privatelink.cn-chengdu.aliyuncs.com</RegionEndpoint>\\n <LocalName>西南1（成都）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>cn-hongkong</RegionId>\\n <RegionEndpoint>privatelink.cn-hongkong.aliyuncs.com</RegionEndpoint>\\n <LocalName>中国香港</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-1</RegionId>\\n <RegionEndpoint>privatelink.ap-southeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>新加坡</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-2</RegionId>\\n <RegionEndpoint>privatelink.ap-southeast-2.aliyuncs.com</RegionEndpoint>\\n <LocalName>澳大利亚（悉尼）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-3</RegionId>\\n <RegionEndpoint>privatelink.ap-southeast-3.aliyuncs.com</RegionEndpoint>\\n <LocalName>马来西亚（吉隆坡）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-southeast-5</RegionId>\\n <RegionEndpoint>privatelink.ap-southeast-5.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度尼西亚（雅加达）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-northeast-1</RegionId>\\n <RegionEndpoint>privatelink.ap-northeast-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>日本（东京）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>eu-central-1</RegionId>\\n <RegionEndpoint>privatelink.eu-central-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>德国（法兰克福）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>eu-west-1</RegionId>\\n <RegionEndpoint>privatelink.eu-west-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>英国（伦敦）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>us-west-1</RegionId>\\n <RegionEndpoint>privatelink.us-west-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（硅谷）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>us-east-1</RegionId>\\n <RegionEndpoint>privatelink.us-east-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>美国（弗吉尼亚）</LocalName>\\n </Region>\\n <Region>\\n <RegionId>ap-south-1</RegionId>\\n <RegionEndpoint>privatelink.ap-south-1.aliyuncs.com</RegionEndpoint>\\n <LocalName>印度（孟买）</LocalName>\\n </Region>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => 'DescribeRegions', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeZones' => [ + 'summary' => 'Queries a list of zones in a specified region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkVQ750H', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the zone. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceResourceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the zone. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The returned zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The name of the zone.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou Zone B', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"LocalName\\": \\"华东1 可用区B\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeZonesResponse>\\r\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\r\\n <Zones>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-b</ZoneId>\\r\\n <LocalName>华东 1 可用区 B</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-f</ZoneId>\\r\\n <LocalName>华东 1 可用区 F</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-g</ZoneId>\\r\\n <LocalName>华东 1 可用区 G</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-h</ZoneId>\\r\\n <LocalName>华东 1 可用区 H</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-i</ZoneId>\\r\\n <LocalName>华东 1 可用区 I</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-j</ZoneId>\\r\\n <LocalName>华东 1 可用区 J</LocalName>\\r\\n </Zone>\\r\\n <Zone>\\r\\n <ZoneId>cn-hangzhou-k</ZoneId>\\r\\n <LocalName>华东 1 可用区 K</LocalName>\\r\\n </Zone>\\r\\n </Zones>\\r\\n</DescribeZonesResponse>","errorExample":""}]', + 'title' => 'DescribeZones', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVpcEndpointService' => [ + 'summary' => 'Creates an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16165', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is my EndpointService.', + ], + ], + [ + 'name' => 'AutoAcceptEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically accept endpoint connection requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Payer', + 'in' => 'query', + 'schema' => [ + 'description' => 'The payer. Valid values:'."\n" + ."\n" + .'* **Endpoint**: service consumer'."\n" + .'* **EndpointService**: service provider'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Endpoint', + ], + ], + [ + 'name' => 'ZoneAffinityEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ServiceResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: Classic Load Balancer (CLB) instance'."\n" + .'* **alb**: Application Load Balancer (ALB) instance'."\n" + .'* **nlb**: Network Load Balancer (NLB) instance'."\n" + ."\n" + .'> You cannot access TCP/SSL listeners configured for NLB instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The service resources of the endpoint service. You can create at most 10 resources. After the resource is created, you can continue to add service resources to the endpoint.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service resources of the endpoint service.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of the service resource that is added to the endpoint service. You can add up to 20 service resources to the endpoint service. Valid values:'."\n" + ."\n" + .'* **slb**: CLB instance'."\n" + .'* **alb**: ALB instance'."\n" + .'* **nlb**: NLB instance'."\n" + ."\n" + .'> In regions where PrivateLink is supported, CLB instances deployed in virtual private clouds (VPCs) can serve as the service resources of the endpoint service. You cannot access TCP/SSL listeners configured for NLB instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + ], + 'ResourceId' => [ + 'description' => 'The ID of the service resource that is added to the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-huhehaote-a', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ServiceSupportIPv6', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable IPv6 for the endpoint service. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => 'The value of the tag to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4** (default)'."\n" + .'* **DualStack**'."\n" + ."\n" + .'> You can set the protocol to DualStack only for endpoint services whose backend resource type is NLB. An endpoint service supports dual-stack only if its backend resources support dual-stack.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IPv4' => 'IPv4', + 'DualStack' => 'DualStack', + ], + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'SupportedRegionList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceBusinessStatus' => [ + 'description' => 'The service state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint service runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint service is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceStatus' => [ + 'description' => 'The state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint service is being created.'."\n" + .'* **Pending**: The endpoint service is being modified.'."\n" + .'* **Active**: The endpoint service is available.'."\n" + .'* **Deleting**: The endpoint service is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'ServiceDescription' => [ + 'description' => 'The description of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'This is my EndpointService.', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint service was created.'."\n", + 'type' => 'string', + 'example' => '2022-01-02T19:11:12Z', + ], + 'ServiceDomain' => [ + 'description' => 'The domain name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'ZoneAffinityEnabled' => [ + 'description' => 'Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoAcceptEnabled' => [ + 'description' => 'Indicates whether the endpoint service automatically accepts endpoint connection requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ServiceId' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceSupportIPv6' => [ + 'description' => 'Indicates whether IPv6 was enabled for the endpoint service. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + 'deprecated' => true, + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmy*****', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'SupportedRegionSet' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceRegionId' => [ + 'type' => 'string', + 'deprecated' => true, + ], + 'RegionServiceStatus' => [ + 'type' => 'string', + ], + 'RegionBusinessStatus' => [ + 'type' => 'string', + ], + 'SupportedRegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceExist', + 'errorMessage' => 'The specified Endpoint Service already exists.', + ], + [ + 'errorCode' => 'AlbNotFound', + 'errorMessage' => 'The specified Alb does not exist.', + ], + [ + 'errorCode' => 'LoadBalancerNotFound', + 'errorMessage' => 'The specified load balancer does not exist.', + ], + [ + 'errorCode' => 'LoadBalancerNotSupportPrivateLink', + 'errorMessage' => 'The specified SLB does not support PrivateLink.', + ], + [ + 'errorCode' => 'GenerateResourceIdFailed', + 'errorMessage' => 'Failed to generate ResourceId.', + ], + [ + 'errorCode' => 'QuotaMisMatched', + 'errorMessage' => 'The resource you applied for has exceeded the quota.', + ], + [ + 'errorCode' => 'VSwitchNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'EndpointServicePayerForbidden', + 'errorMessage' => 'The parameter EndpointServicePayer is forbidden. The user is not in the whitelist.', + ], + [ + 'errorCode' => 'NeedOpenProduct', + 'errorMessage' => 'The product is not activated.', + ], + [ + 'errorCode' => 'EndpointServiceNotSupportedZone', + 'errorMessage' => 'The specified endpoint service does not support the zone.', + ], + [ + 'errorCode' => 'IllegalParamFormat.%s', + 'errorMessage' => 'The param format of %s is illegal.', + ], + [ + 'errorCode' => 'MissingParam.%s', + 'errorMessage' => 'The param of %s is missing.', + ], + [ + 'errorCode' => 'ResourceNotFound.NatGateway', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'Mismatch.ResourceType', + 'errorMessage' => 'The %s is mismatched for %s and %s.', + ], + [ + 'errorCode' => 'EndpointServiceNotSupportIpv6', + 'errorMessage' => 'The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainNotSupport', + 'errorMessage' => 'The operation is not allowed because of PrivateDomainNotSupport.', + ], + [ + 'errorCode' => 'Conflict.ServiceName', + 'errorMessage' => 'The ServiceName %s is conflict.', + ], + [ + 'errorCode' => 'InvalidParam.PrivateDnsName', + 'errorMessage' => 'The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.', + ], + [ + 'errorCode' => 'OperationDenied.ZoneAffinityNotSupport', + 'errorMessage' => 'The operation is not allowed because of zone affinity not support.', + ], + [ + 'errorCode' => 'OperationDenied.RamPolicyNotSupport', + 'errorMessage' => 'The operation is not allowed because of RamPolicyNotSupport.', + ], + [ + 'errorCode' => 'OperationDenied.ResourceTypeNotSupportDualStack', + 'errorMessage' => 'The specified resource type does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.ServiceResourceIpVersionMismatch', + 'errorMessage' => 'The endpoint service and service resource AddressIpVersion do not match.', + ], + [ + 'errorCode' => 'IllegalParam.AddressIpVersion', + 'errorMessage' => 'The specified parameter AddressIpVersion is invalid.', + ], + [ + 'errorCode' => 'SpecifiedAlbNotSupport', + 'errorMessage' => 'The specified alb %s is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ServiceBusinessStatus\\": \\"Normal\\",\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceStatus\\": \\"Active\\",\\n \\"ServiceDescription\\": \\"This is my EndpointService.\\",\\n \\"CreateTime\\": \\"2022-01-02T19:11:12Z\\",\\n \\"ServiceDomain\\": \\"epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"ZoneAffinityEnabled\\": false,\\n \\"AutoAcceptEnabled\\": false,\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceSupportIPv6\\": false,\\n \\"ResourceGroupId\\": \\"rg-acfmy*****\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"SupportedRegionSet\\": [\\n {\\n \\"ServiceRegionId\\": \\"\\",\\n \\"RegionServiceStatus\\": \\"\\",\\n \\"RegionBusinessStatus\\": \\"\\",\\n \\"SupportedRegionId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'CreateVpcEndpointService', + 'description' => '* Before you create an endpoint service, make sure that you have created a Server Load Balancer (SLB) instance that supports PrivateLink. For more information, see [CreateLoadBalancer](~~174064~~).'."\n" + ."\n" + .'* **CreateVpcEndpointService** is an asynchronous operation. After a request is sent, the system returns a request ID and an instance ID and runs the task in the background. You can call the [GetVpcEndpointServiceAttribute](~~183542~~) operation to query the status of the endpoint service.'."\n" + ."\n" + .' * If the endpoint service is in the **Creating** state, the endpoint service is being created.'."\n" + .' * If the endpoint service is in the **Active** state, the endpoint service is created.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateVpcEndpointServiceAttribute' => [ + 'summary' => 'Modifies the attributes of an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '16189', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'ServiceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is my EndpointService.', + ], + ], + [ + 'name' => 'AutoAcceptEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically accept endpoint connection requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ConnectBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default maximum bandwidth of the endpoint connection. Unit: Mbit/s. Default value: **3072**.'."\n" + ."\n" + .'Valid values: **100** to **10240**.'."\n" + ."\n" + .'> You can specify this parameter only if you specify Classic Load Balancer (CLB) instances or Application Load Balancer (ALB) instances as service resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'ZoneAffinityEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceSupportIPv6', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable IPv6. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n" + ."\n" + .'> You can set the protocol to DualStack only for endpoint services whose backend resource type is NLB.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IPv4' => 'IPv4', + 'DualStack' => 'DualStack', + ], + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'AddSupportedRegionSet', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'DeleteSupportedRegionSet', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceLocked', + 'errorMessage' => 'The specified Service is locked.', + ], + [ + 'errorCode' => 'EndpointServiceOperationDenied', + 'errorMessage' => 'The specified operation of endpoint service is not allowed.', + ], + [ + 'errorCode' => 'IllegalParamFormat.%s', + 'errorMessage' => 'The param format of %s is illegal.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateServiceDomainBusinessStatus', + 'errorMessage' => 'The operation is not allowed because of PrivateServiceDomainBusinessStatus.', + ], + [ + 'errorCode' => 'MissingParam.%s', + 'errorMessage' => 'The param of %s is missing.', + ], + [ + 'errorCode' => 'ServiceResourceNotSupportIpv6', + 'errorMessage' => 'The resource is not support ipv6.', + ], + [ + 'errorCode' => 'EndpointServiceDowngradeNotAllowed', + 'errorMessage' => 'The EndpointService is not allowed for downgrade.', + ], + [ + 'errorCode' => 'DependencyViolation.PrivateDnsName', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainNotSupport', + 'errorMessage' => 'The operation is not allowed because of PrivateDomainNotSupport.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainStatusNotSupport', + 'errorMessage' => 'The operation is not allowed because of %s.', + ], + [ + 'errorCode' => 'Conflict.ServiceName', + 'errorMessage' => 'The ServiceName %s is conflict.', + ], + [ + 'errorCode' => 'InvalidParam.PrivateDnsName', + 'errorMessage' => 'The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.', + ], + [ + 'errorCode' => 'OperationDenied.ResourceTypeNotSupportDualStack', + 'errorMessage' => 'The specified resource type does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.ServiceResourceIpVersionMismatch', + 'errorMessage' => 'The endpoint service and service resource AddressIpVersion do not match.', + ], + [ + 'errorCode' => 'EndpointServiceConnectionDependence', + 'errorMessage' => 'There are connections between the endpoint service and the dualstack endpoint, the endpoint service address ip version not support switching from dualstack to ipv4.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVpcEndpointServiceAttributeResponse>\\n <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>\\n</UpdateVpcEndpointServiceAttributeResponse>","errorExample":""}]', + 'title' => 'UpdateVpcEndpointServiceAttribute', + 'description' => 'You cannot repeatedly call the **UpdateVpcEndpointServiceAttribute** operation to modify the attributes of an endpoint service that belongs to an Alibaba Cloud account within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVpcEndpointServiceAttribute' => [ + 'summary' => 'Queries the attributes of an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16175', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Payer' => [ + 'description' => 'The payer of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Endpoint**: the service consumer.'."\n" + .'* **EndpointService**: the service provider.'."\n", + 'type' => 'string', + 'example' => 'Endpoint', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + 'ServiceDescription' => [ + 'description' => 'The description of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'This is my EndpointService.', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint service was created.'."\n", + 'type' => 'string', + 'example' => '2020-01-02T19:11:12Z', + ], + 'MaxBandwidth' => [ + 'description' => 'The maximum bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'MinBandwidth' => [ + 'description' => 'The minimum bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ServiceDomain' => [ + 'description' => 'The domain name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'AutoAcceptEnabled' => [ + 'description' => 'Indicates whether endpoint connection requests are automatically accepted. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneAffinityEnabled' => [ + 'description' => 'Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'Zones' => [ + 'description' => 'The zones to which the service resources belong.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote-b', + ], + ], + 'ServiceBusinessStatus' => [ + 'description' => 'The service status of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint service runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint service is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceStatus' => [ + 'description' => 'The state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint service is being created.'."\n" + .'* **Pending**: The endpoint service is being modified.'."\n" + .'* **Active**: The endpoint service is available.'."\n" + .'* **Deleting**: The endpoint service is being deleted.'."\n" + .'* **Inactive**: The endpoint service is unavailable.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'ConnectBandwidth' => [ + 'description' => 'The default maximum bandwidth of the endpoint connection. Unit: Mbit/s. Valid values: **100** to 10240.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'RegionId' => [ + 'description' => 'The region ID of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'ServiceType' => [ + 'description' => 'The type of the endpoint.'."\n" + ."\n" + .'Only **Interface** is returned. The value indicates the interface endpoint. Then, you can specify ALB and CLB instances as service resources for the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'Interface', + ], + 'ServiceResourceType' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: a CLB instance.'."\n" + .'* **alb**: an ALB instance.'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + 'ServiceSupportIPv6' => [ + 'description' => 'Specifies whether the endpoint service supports IPv6. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmy*****', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'SupportedRegionSet' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceRegionId' => [ + 'type' => 'string', + 'deprecated' => true, + ], + 'RegionServiceStatus' => [ + 'type' => 'string', + ], + 'RegionBusinessStatus' => [ + 'type' => 'string', + ], + 'SupportedRegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Payer\\": \\"Endpoint\\",\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\",\\n \\"ServiceDescription\\": \\"This is my EndpointService.\\",\\n \\"CreateTime\\": \\"2020-01-02T19:11:12Z\\",\\n \\"MaxBandwidth\\": 1024,\\n \\"MinBandwidth\\": 100,\\n \\"ServiceDomain\\": \\"epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"AutoAcceptEnabled\\": true,\\n \\"ZoneAffinityEnabled\\": true,\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"Zones\\": [\\n \\"cn-huhehaote-b\\"\\n ],\\n \\"ServiceBusinessStatus\\": \\"Normal\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceStatus\\": \\"Active\\",\\n \\"ConnectBandwidth\\": 3072,\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"ServiceType\\": \\"Interface\\",\\n \\"ServiceResourceType\\": \\"slb\\",\\n \\"ServiceSupportIPv6\\": false,\\n \\"ResourceGroupId\\": \\"rg-acfmy*****\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"SupportedRegionSet\\": [\\n {\\n \\"ServiceRegionId\\": \\"\\",\\n \\"RegionServiceStatus\\": \\"\\",\\n \\"RegionBusinessStatus\\": \\"\\",\\n \\"SupportedRegionId\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetVpcEndpointServiceAttributeResponse>\\n <Payer>Endpoint</Payer>\\n <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>\\n <ServiceDescription>This is my EndpointService.</ServiceDescription>\\n <CreateTime>2020-01-02T19:11:12Z</CreateTime>\\n <MaxBandwidth>1024</MaxBandwidth>\\n <MinBandwidth>100</MinBandwidth>\\n <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>\\n <AutoAcceptEnabled>true</AutoAcceptEnabled>\\n <ZoneAffinityEnabled>true</ZoneAffinityEnabled>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <Zones>cn-huhehaote-b</Zones>\\n <ServiceBusinessStatus>Normal</ServiceBusinessStatus>\\n <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>\\n <ServiceStatus>Active</ServiceStatus>\\n <ConnectBandwidth>1024</ConnectBandwidth>\\n <RegionId>cn-huhehaote</RegionId>\\n <ServiceType>Interface</ServiceType>\\n <ServiceResourceType>slb</ServiceResourceType>\\n <ServiceSupportIPv6>false</ServiceSupportIPv6>\\n <ResourceGroupId>rg-acfmy*****</ResourceGroupId>\\n</GetVpcEndpointServiceAttributeResponse>","errorExample":""}]', + 'title' => 'GetVpcEndpointServiceAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpointServices' => [ + 'summary' => 'Queries a list of endpoint services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16180', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **1** to **1000**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'ServiceResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: a Classic Load Balancer (CLB) instance'."\n" + .'* **alb**: an Application Load Balancer (ALB) instance'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + ], + ], + [ + 'name' => 'AutoAcceptEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically accept endpoint connection requests. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint service is being created.'."\n" + .'* **Pending**: The endpoint service is being modified.'."\n" + .'* **Active**: The endpoint service is available.'."\n" + .'* **Deleting**: The endpoint service is being deleted'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + [ + 'name' => 'ServiceBusinessStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint service runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint service is locked due to overdue payments.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'ZoneAffinityEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Services' => [ + 'description' => 'The endpoint services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The endpoint services.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoAcceptEnabled' => [ + 'description' => 'Indicates whether endpoint connection requests are automatically accepted. Valid values:'."\n" + ."\n" + .'* **true**: Endpoint connection requests are automatically accepted.'."\n" + .'* **false**: Endpoint connection requests are not automatically accepted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => 'The ID of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint service was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2021-09-24T17:15:10Z', + ], + 'MinBandwidth' => [ + 'description' => 'The minimum bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MaxBandwidth' => [ + 'description' => 'The maximum bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'ServiceStatus' => [ + 'description' => 'The state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint service is being created.'."\n" + .'* **Pending**: The endpoint service is being modified.'."\n" + .'* **Active**: The endpoint service is available.'."\n" + .'* **Deleting**: The endpoint service is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'ZoneAffinityEnabled' => [ + 'description' => 'Indicates whether zone affinity is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => 'The region ID of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'ServiceDomain' => [ + 'description' => 'The domain name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'Payer' => [ + 'description' => 'The payer. Valid values:'."\n" + ."\n" + .'* **Endpoint**: service consumer'."\n" + .'* **EndpointService**: service provider'."\n", + 'type' => 'string', + 'example' => 'Endpoint', + ], + 'ServiceBusinessStatus' => [ + 'description' => 'The service state of the endpoint service. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint service runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint service is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'ConnectBandwidth' => [ + 'description' => 'The default maximum bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceDescription' => [ + 'description' => 'The description of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'This is my EndpointService.', + ], + 'ServiceResourceType' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: Classic Load Balancer (CLB) instance'."\n" + .'* **alb**: Application Load Balancer (ALB) instance'."\n" + .'* **nlb**: Network Load Balancer (NLB) instance'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + 'ServiceType' => [ + 'description' => 'The type of the endpoint service.'."\n" + ."\n" + .'* Only **Interface** may be returned. You can specify CLB, ALB, and NLB instances as the service resources of the endpoint service.'."\n", + 'type' => 'string', + 'example' => 'Interface', + ], + 'ServiceSupportIPv6' => [ + 'description' => 'Indicates whether the endpoint service supports IPv6. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'Tags' => [ + 'description' => 'The tags added to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag added to the resource.'."\n", + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of the tag added to the resource.'."\n", + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmy*****', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'SupportedRegionSet' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceRegionId' => [ + 'type' => 'string', + 'deprecated' => true, + ], + 'RegionServiceStatus' => [ + 'type' => 'string', + ], + 'RegionBusinessStatus' => [ + 'type' => 'string', + ], + 'SupportedRegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Services\\": [\\n {\\n \\"AutoAcceptEnabled\\": true,\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"CreateTime\\": \\"2021-09-24T17:15:10Z\\",\\n \\"MinBandwidth\\": 100,\\n \\"MaxBandwidth\\": 1024,\\n \\"ServiceStatus\\": \\"Active\\",\\n \\"ZoneAffinityEnabled\\": true,\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"ServiceDomain\\": \\"epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"Payer\\": \\"Endpoint\\",\\n \\"ServiceBusinessStatus\\": \\"Normal\\",\\n \\"ConnectBandwidth\\": 1024,\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceDescription\\": \\"This is my EndpointService.\\",\\n \\"ServiceResourceType\\": \\"slb\\",\\n \\"ServiceType\\": \\"Interface\\",\\n \\"ServiceSupportIPv6\\": false,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmy*****\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"SupportedRegionSet\\": [\\n {\\n \\"ServiceRegionId\\": \\"\\",\\n \\"RegionServiceStatus\\": \\"\\",\\n \\"RegionBusinessStatus\\": \\"\\",\\n \\"SupportedRegionId\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": 12\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointServicesResponse>\\n <Services>\\n <AutoAcceptEnabled>true</AutoAcceptEnabled>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <CreateTime>2021-09-24T17:15:10Z</CreateTime>\\n <MinBandwidth>100</MinBandwidth>\\n <MaxBandwidth>1024</MaxBandwidth>\\n <ServiceStatus>Active</ServiceStatus>\\n <ZoneAffinityEnabled>true</ZoneAffinityEnabled>\\n <RegionId>cn-huhehaote</RegionId>\\n <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>\\n <Payer>Endpoint</Payer>\\n <ServiceBusinessStatus>Normal</ServiceBusinessStatus>\\n <ConnectBandwidth>1024</ConnectBandwidth>\\n <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>\\n <ServiceDescription>This is my EndpointService.</ServiceDescription>\\n <ServiceResourceType>slb</ServiceResourceType>\\n <ServiceType>Interface</ServiceType>\\n <ServiceSupportIPv6>false</ServiceSupportIPv6>\\n <Tags>\\n <Key>FinanceDept</Key>\\n <Value>FinanceJoshua</Value>\\n </Tags>\\n <ResourceGroupId>rg-acfmy*****</ResourceGroupId>\\n </Services>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n</ListVpcEndpointServicesResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointServices', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVpcEndpointService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint service that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceOperationDenied', + 'errorMessage' => 'The specified operation of endpoint service is not allowed.', + ], + [ + 'errorCode' => 'EndpointServiceDependenceViolation', + 'errorMessage' => 'The specified EndpointService already contains a resource.', + ], + [ + 'errorCode' => 'EndpointServiceConnectionDependence', + 'errorMessage' => 'You cannot delete EndpointService with Endpoint connected.', + ], + [ + 'errorCode' => 'DeleteFailedDueToEndpointExist', + 'errorMessage' => 'The specified EndpointService id deleted failed , due to EndpointExist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVpcEndpointServiceResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</DeleteVpcEndpointServiceResponse>","errorExample":""}]', + 'title' => 'DeleteVpcEndpointService', + 'summary' => 'Deletes an endpoint service.', + 'description' => '* Before you delete an endpoint service, you must disconnect the endpoint from the endpoint service and remove the service resources.'."\n" + ."\n" + .'* **DeleteVpcEndpointService** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointServiceAttribute](~~183542~~) operation to check whether the endpoint service is deleted.'."\n" + ."\n" + .' * If the endpoint service is in the **Deleting** state, the endpoint service is being deleted.'."\n" + .' * If the endpoint service cannot be queried, the endpoint service is deleted.'."\n" + ."\n" + .'* You cannot repeatedly call the **DeleteVpcEndpointService** operation to delete an endpoint service that belongs to an Alibaba Cloud account within a specified period of time.'."\n", + ], + 'AddUserToVpcEndpointService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account ID that you want to add to the whitelist.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '132193271328****', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'UserARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The whitelist in the format of Aliyun Resource Name (ARN).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram:*:<account-id>:*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'MissingParam.UserArn', + 'errorMessage' => 'The param of UserArn is missing.', + ], + [ + 'errorCode' => 'Mismatch.UserIdAndUserArn', + 'errorMessage' => 'The %s and %s are mismatched.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<AddUserToVpcEndpointServiceResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</AddUserToVpcEndpointServiceResponse>","errorExample":""}]', + 'title' => 'AddUserToVpcEndpointService', + 'summary' => 'Adds an account ID to the whitelist of an endpoint service.', + 'description' => '* Before you add an account ID to the whitelist of an endpoint service, make sure that the endpoint service is in the **Active** state. You can call the [GetVpcEndpointServiceAttribute](~~469330~~) operation to query the status of the endpoint service.'."\n" + .'* You cannot repeatedly call the **AddUserToVpcEndpointService** operation to add the ID of an Alibaba Cloud account to the whitelist of an endpoint service within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpointServiceUsers' => [ + 'summary' => 'Queries the whitelist of an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service that you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the value to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **1 to 50**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account in the whitelist of the endpoint service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '12345678', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service that you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'UserListType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the user list in the whitelist of the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Users', + 'default' => 'Users', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Users' => [ + 'description' => 'The Alibaba Cloud accounts in the whitelist of the endpoint service.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => 'The ID of the Alibaba Cloud account in the whitelist of the endpoint service.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345678', + ], + ], + 'description' => '', + ], + ], + 'UserARNs' => [ + 'description' => 'The whitelists in the format of Aliyun Resource Name (ARN).'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserARN' => [ + 'description' => 'The whitelist in the format of ARN.'."\n", + 'type' => 'string', + 'example' => 'acs:ram:*::*', + ], + ], + 'description' => '', + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"Users\\": [\\n {\\n \\"UserId\\": 12345678\\n }\\n ],\\n \\"UserARNs\\": [\\n {\\n \\"UserARN\\": \\"acs:ram:*::*\\"\\n }\\n ],\\n \\"TotalCount\\": \\"3\\"\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointServiceUsersResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n <Users>\\n <UserId>12345678</UserId>\\n </Users>\\n <UserARNs/>\\n</ListVpcEndpointServiceUsersResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointServiceUsers', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveUserFromVpcEndpointService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service for which you want to remove the account ID from the whitelist. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the AccessKey pair, the permissions of the RAM user, and the required parameters. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account ID that you want to remove from the whitelist.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '12345678', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service for which you want to remove the account ID from the whitelist. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'UserARN', + 'in' => 'query', + 'schema' => [ + 'description' => 'The whitelist in the format of Aliyun Resource Name (ARN).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram:*:<account-id>:*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'MissingParam.UserArn', + 'errorMessage' => 'The param of UserArn is missing.', + ], + [ + 'errorCode' => 'Mismatch.UserIdAndUserArn', + 'errorMessage' => 'The %s and %s are mismatched.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveUserFromVpcEndpointServiceResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</RemoveUserFromVpcEndpointServiceResponse>","errorExample":""}]', + 'title' => 'RemoveUserFromVpcEndpointService', + 'summary' => 'Removes an account ID from the whitelist of an endpoint service.', + 'description' => '* Before you remove an account ID from the whitelist of an endpoint service, make sure that the endpoint service is in the **Active** state. You can call the [GetVpcEndpointServiceAttribute](~~469330~~) operation to query the status of the endpoint service.'."\n" + .'* You cannot repeatedly call the **RemoveUserFromVpcEndpointService** operation to remove the ID of an Alibaba Cloud account from the whitelist of an endpoint service within a specified period of time.'."\n", + ], + 'UpdateVpcEndpointServiceResourceAttribute' => [ + 'summary' => 'Modifies whether whether service resources are automatically allocated for an endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the service resource is deployed.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform a dry run. Valid values:'."\n" + ."\n" + .'* **true**: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false**: performs a dry run and sends the request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed. This is the default value.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the service resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'AutoAllocatedEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic resource allocation. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the service resource is deployed.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceLocked', + 'errorMessage' => 'The specified Service is locked.', + ], + [ + 'errorCode' => 'EndpointServiceOperationDenied', + 'errorMessage' => 'The specified operation of endpoint service is not allowed.', + ], + [ + 'errorCode' => 'EndpointServiceResourceNotFound', + 'errorMessage' => 'The specified service resource is not found.', + ], + [ + 'errorCode' => 'ResourceAutoAllocateViolation', + 'errorMessage' => 'The specified endpoint service must have at least one automatically allocated resource in one zone.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVpcEndpointServiceResourceAttributeResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</UpdateVpcEndpointServiceResourceAttributeResponse>","errorExample":""}]', + 'title' => 'UpdateVpcEndpointServiceResourceAttribute', + 'description' => 'You cannot repeatedly call the **UpdateVpcEndpointServiceResourceAttribute** operation to modify the attributes of a service resource that is added to an endpoint service within a specified period of time.'."\n", + ], + 'AttachResourceToVpcEndpointService' => [ + 'summary' => 'Adds a service resource to an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16162', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkZR0ZOX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service to which you want to add the service resource.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~448570~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: Classic Load Balancer (CLB) instance'."\n" + .'* **alb**: Application Load Balancer (ALB) instance'."\n" + .'* **nlb**: Network Load Balancer (NLB) instance'."\n" + ."\n" + .'> You cannot access TCP/SSL listeners configured for NLB instances.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'slb', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID of the service resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint service to which you want to add the service resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint service to which you want to add the service resource.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~448570~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceOperationDenied', + 'errorMessage' => 'The specified operation of endpoint service is not allowed.', + ], + [ + 'errorCode' => 'EndpointServiceResourceExist', + 'errorMessage' => 'The specified resource already exists.', + ], + [ + 'errorCode' => 'LoadBalancerNotFound', + 'errorMessage' => 'The specified load balancer does not exist.', + ], + [ + 'errorCode' => 'LoadBalancerNotSupportPrivateLink', + 'errorMessage' => 'The specified SLB does not support PrivateLink.', + ], + [ + 'errorCode' => 'AlbNotFound', + 'errorMessage' => 'The specified Alb does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceResourceTypeNotSupport', + 'errorMessage' => 'The specified resource type is not supported.', + ], + [ + 'errorCode' => 'QuotaMisMatched', + 'errorMessage' => 'The resource you applied for has exceeded the quota.', + ], + [ + 'errorCode' => 'VSwitchNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'ResourceNotFound.NatGateway', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'Mismatch.ResourceType', + 'errorMessage' => 'The %s is mismatched for %s and %s.', + ], + [ + 'errorCode' => 'EndpointServiceNotSupportedZone', + 'errorMessage' => 'The specified endpoint service does not support the zone.', + ], + [ + 'errorCode' => 'ServiceResourceNotSupportIpv6', + 'errorMessage' => 'The resource is not support ipv6.', + ], + [ + 'errorCode' => 'EndpointServiceResourceTypeNotEqual', + 'errorMessage' => 'the service resource type not equal request type.', + ], + [ + 'errorCode' => 'OperationDenied.ServiceResourceIpVersionMismatch', + 'errorMessage' => 'The endpoint service and service resource AddressIpVersion do not match.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachResourceToVpcEndpointServiceResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</AttachResourceToVpcEndpointServiceResponse>","errorExample":""}]', + 'title' => 'AttachResourceToVpcEndpointService', + 'description' => '* Before you add a service resource to an endpoint service, make sure that the endpoint service is in the **Active** state. You can call the [GetVpcEndpointServiceAttribute](~~469330~~) operation to query the status of the endpoint service.'."\n" + .'* You cannot repeatedly call the **AttachResourceToVpcEndpointService** operation to add a service resource to an endpoint service within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpointServiceResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the service resource.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **1** to **50**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the service resource.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Resources' => [ + 'description' => 'The service resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the service resource belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-hp356stwkxg3fn2xe****', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch to which the service resource belongs.'."\n", + 'type' => 'string', + 'example' => 'vsw-hp3uf6045ljdhd5zr****', + ], + 'ResourceType' => [ + 'description' => 'The type of the service resource.'."\n" + ."\n" + .'Only **slb** is returned. This value indicates a Classic Load Balancer (CLB) instance.'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone to which the service resource belongs.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote-b', + ], + 'Ip' => [ + 'description' => 'The IP address of the service resource.'."\n", + 'type' => 'string', + 'example' => '192.168.10.23', + ], + 'ResourceId' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + 'RegionId' => [ + 'description' => 'The ID of the region where the service resource is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'RelatedEndpointCount' => [ + 'description' => 'The number of endpoints that are associated with the service resource.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RelatedDeprecatedEndpointCount' => [ + 'description' => 'The number of endpoints that are associated with the service resource that is smoothly migrated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AutoAllocatedEnabled' => [ + 'description' => 'Indicates whether automatic resource allocation is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceSupportIPv6' => [ + 'description' => 'Indicates whether IPv6 is enabled for the endpoint service. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"Resources\\": [\\n {\\n \\"VpcId\\": \\"vpc-hp356stwkxg3fn2xe****\\",\\n \\"VSwitchId\\": \\"vsw-hp3uf6045ljdhd5zr****\\",\\n \\"ResourceType\\": \\"slb\\",\\n \\"ZoneId\\": \\"cn-huhehaote-b\\",\\n \\"Ip\\": \\"192.168.10.23\\",\\n \\"ResourceId\\": \\"lb-hp32z1wp5peaoox2q****\\",\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"RelatedEndpointCount\\": 10,\\n \\"RelatedDeprecatedEndpointCount\\": 10,\\n \\"AutoAllocatedEnabled\\": false,\\n \\"ResourceSupportIPv6\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointServiceResourcesResponse>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n <Resources>\\n <VpcId>vpc-hp356stwkxg3fn2xe****</VpcId>\\n <VSwitchId>vsw-hp3uf6045ljdhd5zr****</VSwitchId>\\n <ResourceType>slb</ResourceType>\\n <ZoneId>cn-huhehaote-b</ZoneId>\\n <Ip>192.168.10.23</Ip>\\n <ResourceId>lb-hp32z1wp5peaoox2q****</ResourceId>\\n <RegionId>cn-huhehaote</RegionId>\\n <RelatedEndpointCount>10</RelatedEndpointCount>\\n <RelatedDeprecatedEndpointCount>10</RelatedDeprecatedEndpointCount>\\n <AutoAllocatedEnabled>false</AutoAllocatedEnabled>\\n <ResourceSupportIPv6>false</ResourceSupportIPv6>\\n </Resources>\\n</ListVpcEndpointServiceResourcesResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointServiceResources', + 'summary' => 'Queries the service resources that are added to an endpoint service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachResourceFromVpcEndpointService' => [ + 'summary' => 'Removes a service resource from an endpoint service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: a Classic Load Balancer (CLB) instance that supports PrivateLink. In addition, the CLB instance is deployed in a virtual private cloud (VPC).'."\n" + .'* **alb**: an Application Load Balancer (ALB) instance that supports PrivateLink. In addition, the ALB instance is deployed in a VPC.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'slb', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone that you want to remove.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-c', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate a value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceResourceNotFound', + 'errorMessage' => 'The specified service resource is not found.', + ], + [ + 'errorCode' => 'EndpointServiceResourceCannotRemove', + 'errorMessage' => 'The service resource cannot be removed.', + ], + [ + 'errorCode' => 'EndpointServiceConnectionDependence', + 'errorMessage' => 'You cannot delete EndpointService with Endpoint connected.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachResourceFromVpcEndpointServiceResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</DetachResourceFromVpcEndpointServiceResponse>","errorExample":""}]', + 'title' => 'DetachResourceFromVpcEndpointService', + 'description' => '* Before you remove a service resource from an endpoint service, make sure that the endpoint service is in the **Active** state. You can call the [GetVpcEndpointServiceAttribute](~~469330~~) operation to query the status of the endpoint service.'."\n" + .'* You cannot repeatedly call the **DetachResourceFromVpcEndpointService** operation to remove a service resource from an endpoint service within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteVpcEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '16166', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkG9DJDQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to delete. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to delete. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.EndpointProtected', + 'errorMessage' => 'The operation is not allowed because of EndpointProtected.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointDependenceViolation', + 'errorMessage' => 'The specified endpoint has dependent zone(s).', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointProtected', + 'errorMessage' => 'The specified Endpoint is protected.', + ], + [ + 'errorCode' => 'EndpointAssociatedVpc', + 'errorMessage' => 'The endpoint is associated with a vpc.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVpcEndpointResponse>\\n <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>\\n</DeleteVpcEndpointResponse>","errorExample":""}]', + 'title' => 'DeleteVpcEndpoint', + 'summary' => 'Deletes an endpoint.', + 'description' => '* Before you delete an endpoint, you must delete the zones that are added to the endpoint.'."\n" + ."\n" + .'* **DeleteVpcEndpoint** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointAttribute](~~183568~~) operation to check whether the endpoint is deleted.'."\n" + ."\n" + .' * If the endpoint is in the **Deleting** state, the endpoint is being deleted.'."\n" + .' * If the endpoint cannot be queried, the endpoint is deleted.'."\n", + ], + 'CreateVpcEndpoint' => [ + 'summary' => 'Creates an endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16164', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkG9DJDQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint.'."\n" + ."\n" + .'The name must be 2 to 128 characters in length, and can contain digits, underscores (\\_), and hyphens (-). The name must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint type. Valid values:'."\n" + ."\n" + .'* **Interface** You can specify an Application Load Balancer (ALB) instance, a Classic Load Balancer (CLB) instance, or a Network Load Balancer (NLB) instance.'."\n" + .'* **Reverse** You can specify a Virtual Private Cloud (VPC) NAT gateway.'."\n" + ."\n" + .'> Services that support reverse endpoints are provided by Alibaba Cloud or Alibaba Cloud partners. To create such a service on your own, contact your account manager.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Interface', + ], + ], + [ + 'name' => 'ZonePrivateIpAddressCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Set the value to **1**.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the endpoint.'."\n" + ."\n" + .'The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is my Endpoint.', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the endpoint belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-hp356stwkxg3fn2xe****', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'epsrv-hp3xdsq46ael67lo****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'Zone', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The zones where the endpoint is deployed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the zone in the current region.'."\n" + ."\n" + .'Resources are deployed in the specified zone.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch for which you want to create the endpoint elastic network interface (ENI) in the zone. You can specify up to 10 vSwitches.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-hp3uf6045ljdhd5zr****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone where the endpoint service is deployed.'."\n" + ."\n" + .'You can specify up to 10 zones.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-huhehaote-b', + ], + 'ip' => [ + 'description' => 'The IP address of the zone where the endpoint is deployed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + 'Ipv6Address' => [ + 'description' => 'The IPv6 address of the zone where the endpoint is deployed.'."\n" + ."\n" + .'> You can specify this parameter only if AddressIpVersion is set to DualStack.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2408:4005:34d:****:a58b:62a3:6b55:****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of security groups that are associated with the endpoint elastic network interface (ENI).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the virtual private cloud (VPC) and the endpoint ENI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1fg655nh68xyz9****', + ], + 'required' => false, + 'example' => 'sg-hp33bw6ynvm2yb0e****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ProtectedEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:'."\n" + ."\n" + .'* **true**: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.'."\n" + .'* **false** (default): disables user authentication.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags to add to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag to add to the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => 'The value of the tag to add to the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Effect": "Allow",'."\n" + .' "Action": ['."\n" + .' "oss:List*",'."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:oss:oss-*:*:pvl-policy-test/policy-test.txt"'."\n" + .' ],'."\n" + .' "Principal": {'."\n" + .' "RAM": ['."\n" + .' "acs:ram::14199xxxxxx:*"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4** (default)'."\n" + .'* **DualStack**'."\n" + ."\n" + .'> An endpoint supports dual-stack if its associated endpoint service and VPC both support dual-stack.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IPv4' => 'IPv4', + 'DualStack' => 'DualStack', + ], + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'ZoneAffinityEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CrossRegionBandwidth', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndpointDomain' => [ + 'description' => 'The domain name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint was created.'."\n", + 'type' => 'string', + 'example' => '2022-01-02T19:11:12Z', + ], + 'EndpointBusinessStatus' => [ + 'description' => 'The service state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'EndpointDescription' => [ + 'description' => 'The description of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'This is my Endpoint.', + ], + 'ServiceId' => [ + 'description' => 'The ID of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'EndpointStatus' => [ + 'description' => 'The state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint is being created.'."\n" + .'* **Active**: The endpoint is available.'."\n" + .'* **Pending**: The endpoint is being modified.'."\n" + .'* **Deleting**: The endpoint is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-hp356stwkxg3fn2xe****', + ], + 'EndpointName' => [ + 'description' => 'The name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'EndpointId' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****', + ], + 'ConnectionStatus' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The connection is being modified.'."\n" + .'* **Connecting**: The connection is being established.'."\n" + .'* **Connected**: The connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The connection is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Disconnected', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4** (default)'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'ZoneAffinityEnabled' => [ + 'type' => 'boolean', + ], + 'ServiceRegionId' => [ + 'type' => 'string', + ], + 'CrossRegionBandwidth' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointExist', + 'errorMessage' => 'The specified Endpoint already exists.', + ], + [ + 'errorCode' => 'EndpointZoneDuplicated', + 'errorMessage' => 'The zone is duplicated for the Endpoint.', + ], + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceNotSupportedZone', + 'errorMessage' => 'The specified endpoint service does not support the zone.', + ], + [ + 'errorCode' => 'VSwitchNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'SecurityGroupNotFound', + 'errorMessage' => 'The specified security group does not exist.', + ], + [ + 'errorCode' => 'VpcTunnelNotFound', + 'errorMessage' => 'The specified VPC tunnel does not exist.', + ], + [ + 'errorCode' => 'VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'GenerateResourceIdFailed', + 'errorMessage' => 'Failed to generate ResourceId.', + ], + [ + 'errorCode' => 'QuotaMisMatched', + 'errorMessage' => 'The resource you applied for has exceeded the quota.', + ], + [ + 'errorCode' => 'EndpointMustContainSecurityGroup', + 'errorMessage' => 'The specified endpoint must have at least one security group.', + ], + [ + 'errorCode' => 'EndpointDuplicated', + 'errorMessage' => 'The endpoint of the service already exists and cannot be created again.', + ], + [ + 'errorCode' => 'EndpointServiceDeleted', + 'errorMessage' => 'The specified Service is already deleted.', + ], + [ + 'errorCode' => 'EndpointServiceResourceNotFound', + 'errorMessage' => 'The specified service resource is not found.', + ], + [ + 'errorCode' => 'SecurityGroupTypeNotSupport', + 'errorMessage' => 'The specified security group type is not supported.', + ], + [ + 'errorCode' => 'EniIpUnavailable', + 'errorMessage' => 'The specified IP address is unavailable.', + ], + [ + 'errorCode' => 'EndpointServiceNotAuthorized', + 'errorMessage' => 'The specified endpoint service is not authorized to user.', + ], + [ + 'errorCode' => 'SecurityGroupTypeOnlySingleTypeSupporteded', + 'errorMessage' => 'The specified security group only support one type.', + ], + [ + 'errorCode' => 'QuotaExceeded.IpQuotaPerEp', + 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.', + ], + [ + 'errorCode' => 'Mismatch.EndpointType', + 'errorMessage' => 'The %s is mismatched for %s and %s.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointService', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'CheckServiceLinkRoleError', + 'errorMessage' => 'The ServiceLink role check error.', + ], + [ + 'errorCode' => 'ResourceNotEnough.VSwitchIp', + 'errorMessage' => 'The specified resource of VSwitchIp is not enough.', + ], + [ + 'errorCode' => 'VSwitchStatusNotAllowed', + 'errorMessage' => 'The specified vswitch status is not Available.', + ], + [ + 'errorCode' => 'QuotaExceeded.epZonePerEndpoint', + 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.', + ], + [ + 'errorCode' => 'QuotaExceeded.totalEpPerVpc', + 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.', + ], + [ + 'errorCode' => 'QuotaExceeded.totalIdleEndpoint', + 'errorMessage' => 'The quota of %s is exceeded, usage %s/%s.', + ], + [ + 'errorCode' => 'OperationDenied.EndpointPolicyNotSupport', + 'errorMessage' => 'The operation is not allowed because of EndpointPolicyNotSupport.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainStatusNotSupport', + 'errorMessage' => 'The operation is not allowed because of %s.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainNotSupport', + 'errorMessage' => 'The operation is not allowed because of PrivateDomainNotSupport.', + ], + [ + 'errorCode' => 'DependencyViolation.PrivateDnsName', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportSecurityGroup', + 'errorMessage' => 'The gateway load balancer not support security group.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerZoneCountDeny', + 'errorMessage' => 'The GatewayLoadBalancer zone count not support', + ], + [ + 'errorCode' => 'OperationDenied.EndpointTypeNotSupportDualstack', + 'errorMessage' => 'The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.', + ], + [ + 'errorCode' => 'OperationDenied.EndpointServiceNotSupportDualstack', + 'errorMessage' => 'The specified endpoint service does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.VSwitchNotSupportDualstack', + 'errorMessage' => 'The specified VSwitch does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.AddressIpVersionNotSupportSpecifyIpv6', + 'errorMessage' => 'The AddressIpVersion of the endpoint does not support specifying IPv6 address.', + ], + [ + 'errorCode' => 'IllegalParam.Ip', + 'errorMessage' => 'The specified parameter IP is invalid.', + ], + [ + 'errorCode' => 'IllegalParam.Ipv6Address', + 'errorMessage' => 'The specified parameter Ipv6Address is invalid.', + ], + [ + 'errorCode' => 'IllegalParam.AddressIpVersion', + 'errorMessage' => 'The specified parameter AddressIpVersion is invalid.', + ], + [ + 'errorCode' => 'SpecifiedAlbNotSupport', + 'errorMessage' => 'The specified alb %s is not supported.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndpointDomain\\": \\"ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"CreateTime\\": \\"2022-01-02T19:11:12Z\\",\\n \\"EndpointBusinessStatus\\": \\"Normal\\",\\n \\"EndpointDescription\\": \\"This is my Endpoint.\\",\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"EndpointStatus\\": \\"Active\\",\\n \\"VpcId\\": \\"vpc-hp356stwkxg3fn2xe****\\",\\n \\"EndpointName\\": \\"test\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****\\",\\n \\"Bandwidth\\": 200,\\n \\"EndpointId\\": \\"ep-hp33b2e43fays7s8****\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"ZoneAffinityEnabled\\": false,\\n \\"ServiceRegionId\\": \\"\\",\\n \\"CrossRegionBandwidth\\": 0\\n}","type":"json"}]', + 'title' => 'CreateVpcEndpoint', + 'description' => '**CreateVpcEndpoint** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointAttribute](~~183568~~) operation to check whether the endpoint is created.'."\n" + ."\n" + .'* If the endpoint is in the **Creating** state, the endpoint is being created.'."\n" + .'* If the endpoint is in the **Active** state, the endpoint is created.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateVpcEndpointAttribute' => [ + 'summary' => 'Modifies the attributes of an endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16187', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkG9DJDQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint whose attributes you want to modify. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID whose attributes you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint.'."\n" + ."\n" + .'The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). The name must start with a letter.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'EndpointDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the endpoint.'."\n" + ."\n" + .'The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'This is my Endpoint.', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint whose attributes you want to modify. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'PolicyDocument', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Effect": "Allow",'."\n" + .' "Action": ['."\n" + .' "oss:List*",'."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:oss:oss-*:*:pvl-policy-test/policy-test.txt"'."\n" + .' ],'."\n" + .' "Principal": {'."\n" + .' "RAM": ['."\n" + .' "acs:ram::14199xxxxxx:*"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n" + ."\n" + .'> An endpoint supports dual-stack only if its associated endpoint service and VPC support dual-stack.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IPv4' => 'IPv4', + 'DualStack' => 'DualStack', + ], + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'ZoneAffinityEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'ResetPolicy', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'CrossRegionBandwidth', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.EndpointProtected', + 'errorMessage' => 'The operation is not allowed because of EndpointProtected.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointServiceDeleted', + 'errorMessage' => 'The specified Service is already deleted.', + ], + [ + 'errorCode' => 'EndpointProtected', + 'errorMessage' => 'The specified Endpoint is protected.', + ], + [ + 'errorCode' => 'OperationDenied.EndpointPolicyNotSupport', + 'errorMessage' => 'The operation is not allowed because of EndpointPolicyNotSupport.', + ], + [ + 'errorCode' => 'DependencyViolation.PrivateDnsName', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainStatusNotSupport', + 'errorMessage' => 'The operation is not allowed because of %s.', + ], + [ + 'errorCode' => 'OperationDenied.PrivateDomainNotSupport', + 'errorMessage' => 'The operation is not allowed because of PrivateDomainNotSupport.', + ], + [ + 'errorCode' => 'OperationDenied.NotSupportDualStackSwitchToIpv4', + 'errorMessage' => 'AddressIpVersion does not support switching from DualStack to IPv4.', + ], + [ + 'errorCode' => 'OperationDenied.EndpointServiceNotSupportDualstack', + 'errorMessage' => 'The specified endpoint service does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.VSwitchNotSupportDualstack', + 'errorMessage' => 'The specified VSwitch does not support dualstack.', + ], + [ + 'errorCode' => 'IllegalParam.AddressIpVersion', + 'errorMessage' => 'The specified parameter AddressIpVersion is invalid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVpcEndpointAttributeResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</UpdateVpcEndpointAttributeResponse>","errorExample":""}]', + 'title' => 'UpdateVpcEndpointAttribute', + 'description' => 'You cannot repeatedly call the **UpdateVpcEndpointAttribute** operation to modify the attributes of an endpoint that belongs to an Alibaba Cloud account within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpoints' => [ + 'summary' => 'Queries a list of endpoints.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16177', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkG9DJDQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **1** to **1000**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC to which the endpoint belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-fdjkf789dfdfdfde****', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Interface**: interface endpoint'."\n" + .'* **Reverse**: reverse endpoint'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Interface', + ], + ], + [ + 'name' => 'EndpointStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint is being created.'."\n" + .'* **Active**: The endpoint is available.'."\n" + .'* **Pending**: The endpoint is being modified.'."\n" + .'* **Deleting**: The endpoint is being deleted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + [ + 'name' => 'ConnectionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The endpoint connection is being modified.'."\n" + .'* **Connecting**: The endpoint connection is being established.'."\n" + .'* **Connected**: The endpoint connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The connection is being deleted.'."\n" + .'* **ServiceDeleted**: The corresponding endpoint service has been deleted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Disconnected', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag added to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AddressIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Endpoints' => [ + 'description' => 'The information about the endpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the endpoints.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-hp356stwkxg3fn2xe****', + ], + 'EndpointName' => [ + 'description' => 'The name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'EndpointType' => [ + 'description' => 'The type of the endpoint. Valid values:'."\n" + ."\n" + .'* **Interface**: interface endpoint'."\n" + .'* **Reverse**: reverse endpoint'."\n", + 'type' => 'string', + 'example' => 'Interface', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint was created.'."\n", + 'type' => 'string', + 'example' => '2021-09-24T18:00:07Z', + ], + 'ServiceId' => [ + 'description' => 'The ID of the endpoint service that is associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'ZoneAffinityEnabled' => [ + 'description' => 'Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndpointDomain' => [ + 'description' => 'The domain name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'EndpointStatus' => [ + 'description' => 'The state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint is being created.'."\n" + .'* **Active**: The endpoint is available.'."\n" + .'* **Pending**: The endpoint is being modified.'."\n" + .'* **Deleting**: The endpoint is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'RegionId' => [ + 'description' => 'The region ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'ResourceOwner' => [ + 'description' => 'Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'ConnectionStatus' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The endpoint connection is being modified.'."\n" + .'* **Connecting**: The endpoint connection is being established.'."\n" + .'* **Connected**: The endpoint connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The endpoint connection is being deleted.'."\n" + .'* **ServiceDeleted**: The corresponding service is deleted.'."\n", + 'type' => 'string', + 'example' => 'Disconnected', + ], + 'EndpointDescription' => [ + 'description' => 'The description of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'This is my Endpoint.', + ], + 'EndpointId' => [ + 'description' => 'The ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****', + ], + 'EndpointBusinessStatus' => [ + 'description' => 'The service state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service that is associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****', + ], + 'Tags' => [ + 'description' => 'The tags added to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag list.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag added to the resource.'."\n", + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of the tag added to the resource.'."\n", + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PolicyDocument' => [ + 'description' => 'The Resource Access Management (RAM) policy. For more information about policy definitions, see [Policy elements](~~93738~~).'."\n", + 'type' => 'string', + 'example' => '{\\n \\"Version\\": \\"1\\",\\n \\"Statement\\": [\\n {\\n \\"Effect\\": \\"Allow\\",\\n \\"Action\\": \\"*\\",\\n \\"Principal\\": \\"*\\",\\n \\"Resource\\": \\"*\\"\\n }\\n ]\\n}', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'ServiceRegionId' => [ + 'type' => 'string', + ], + 'CrossRegionBandwidth' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Endpoints\\": [\\n {\\n \\"VpcId\\": \\"vpc-hp356stwkxg3fn2xe****\\",\\n \\"EndpointName\\": \\"test\\",\\n \\"EndpointType\\": \\"Interface\\",\\n \\"CreateTime\\": \\"2021-09-24T18:00:07Z\\",\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ZoneAffinityEnabled\\": true,\\n \\"EndpointDomain\\": \\"ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"EndpointStatus\\": \\"Active\\",\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"ResourceOwner\\": true,\\n \\"Bandwidth\\": 1024,\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"EndpointDescription\\": \\"This is my Endpoint.\\",\\n \\"EndpointId\\": \\"ep-hp33b2e43fays7s8****\\",\\n \\"EndpointBusinessStatus\\": \\"Normal\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"1\\",\\n \\"PolicyDocument\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"Version\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Statement\\\\\\\\\\\\\\": [\\\\\\\\n {\\\\\\\\n \\\\\\\\\\\\\\"Effect\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Allow\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Action\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Principal\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"Resource\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"*\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n ]\\\\\\\\n}\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"ServiceRegionId\\": \\"\\",\\n \\"CrossRegionBandwidth\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": 12\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointsResponse>\\n <Endpoints>\\n <VpcId>vpc-hp356stwkxg3fn2xe****</VpcId>\\n <EndpointName>test</EndpointName>\\n <EndpointType>Interface</EndpointType>\\n <CreateTime>2021-09-24T18:00:07Z</CreateTime>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <ZoneAffinityEnabled>true</ZoneAffinityEnabled>\\n <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>\\n <EndpointStatus>Active</EndpointStatus>\\n <RegionId>cn-huhehaote</RegionId>\\n <ResourceOwner>true</ResourceOwner>\\n <Bandwidth>1024</Bandwidth>\\n <ConnectionStatus>Disconnected</ConnectionStatus>\\n <EndpointDescription>This is my Endpoint.</EndpointDescription>\\n <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>\\n <EndpointBusinessStatus>Normal</EndpointBusinessStatus>\\n <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>\\n <Tags>\\n <Key>FinanceDept</Key>\\n <Value>FinanceJoshua</Value>\\n </Tags>\\n <ResourceGroupId>1</ResourceGroupId>\\n </Endpoints>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n</ListVpcEndpointsResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpoints', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVpcEndpointAttribute' => [ + 'summary' => 'Queries the attributes of an endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16174', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkG9DJDQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint whose attributes you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~448570~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint whose attributes you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint whose attributes you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~448570~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Payer' => [ + 'description' => 'The payer. Valid values:'."\n" + ."\n" + .'* **Endpoint**: the service consumer.'."\n" + .'* **EndpointService**: the service provider.'."\n", + 'type' => 'string', + 'example' => 'Endpoint', + ], + 'EndpointDomain' => [ + 'description' => 'The domain name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + 'CreateTime' => [ + 'description' => 'The time when the endpoint was created.'."\n", + 'type' => 'string', + 'example' => '2021-09-24T18:00:07Z', + ], + 'ResourceOwner' => [ + 'description' => 'Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* **true**: The endpoint and the endpoint service belong to the same Alibaba Cloud account.'."\n" + .'* **false**: The endpoint and the endpoint service do not belong to the same Alibaba Cloud account.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndpointBusinessStatus' => [ + 'description' => 'The service state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Normal**: The endpoint runs as expected.'."\n" + .'* **FinancialLocked**: The endpoint is locked due to overdue payments.'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + 'EndpointDescription' => [ + 'description' => 'The description of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'This is my Endpoint.', + ], + 'ServiceId' => [ + 'description' => 'The ID of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'EndpointStatus' => [ + 'description' => 'The state of the endpoint. Valid values:'."\n" + ."\n" + .'* **Creating**: The endpoint is being created.'."\n" + .'* **Active**: The endpoint is available.'."\n" + .'* **Pending**: The endpoint is being modified.'."\n" + .'* **Deleting**: The endpoint is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-fdfhkjafhjvcvdjf****', + ], + 'EndpointName' => [ + 'description' => 'The name of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ZonePrivateIpAddressCount' => [ + 'description' => 'The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only **1** is returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EndpointType' => [ + 'description' => 'The type of the endpoint.'."\n" + ."\n" + .'**Interface** is returned. The value indicates the interface endpoint with which the Classic Load Balancer (CLB) instances are associated.'."\n", + 'type' => 'string', + 'example' => 'Interface', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service with which the endpoint is associated.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the endpoint connection. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'EndpointId' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****', + ], + 'RegionId' => [ + 'description' => 'The region ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'ConnectionStatus' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The connection is being modified.'."\n" + .'* **Connecting**: The connection is being established.'."\n" + .'* **Connected**: The connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The connection is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Connected', + ], + 'ZoneAffinityEnabled' => [ + 'description' => 'Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmz7nocpei***', + ], + 'PolicyDocument' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": ['."\n" + .' {'."\n" + .' "Effect": "Allow",'."\n" + .' "Action": ['."\n" + .' "oss:List*",'."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:oss:oss-*:*:pvl-policy-test/policy-test.txt"'."\n" + .' ],'."\n" + .' "Principal": {'."\n" + .' "RAM": ['."\n" + .' "acs:ram::14199xxxxxx:*"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'ServiceRegionId' => [ + 'type' => 'string', + ], + 'CrossRegionBandwidth' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Payer\\": \\"Endpoint\\",\\n \\"EndpointDomain\\": \\"ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\",\\n \\"CreateTime\\": \\"2021-09-24T18:00:07Z\\",\\n \\"ResourceOwner\\": true,\\n \\"EndpointBusinessStatus\\": \\"Normal\\",\\n \\"EndpointDescription\\": \\"This is my Endpoint.\\",\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"EndpointStatus\\": \\"Active\\",\\n \\"VpcId\\": \\"vpc-fdfhkjafhjvcvdjf****\\",\\n \\"EndpointName\\": \\"test\\",\\n \\"ZonePrivateIpAddressCount\\": 1,\\n \\"EndpointType\\": \\"Interface\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****\\",\\n \\"Bandwidth\\": 1024,\\n \\"EndpointId\\": \\"ep-hp33b2e43fays7s8****\\",\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"ZoneAffinityEnabled\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmz7nocpei***\\",\\n \\"PolicyDocument\\": \\"{\\\\n \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"Statement\\\\\\": [\\\\n {\\\\n \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\n \\\\\\"Action\\\\\\": [\\\\n \\\\\\"oss:List*\\\\\\",\\\\n \\\\\\"oss:PutObject\\\\\\",\\\\n \\\\\\"oss:GetObject\\\\\\"\\\\n ],\\\\n \\\\\\"Resource\\\\\\": [\\\\n \\\\\\"acs:oss:oss-*:*:pvl-policy-test/policy-test.txt\\\\\\"\\\\n ],\\\\n \\\\\\"Principal\\\\\\": {\\\\n \\\\\\"RAM\\\\\\": [\\\\n \\\\\\"acs:ram::14199xxxxxx:*\\\\\\"\\\\n ]\\\\n }\\\\n }\\\\n ]\\\\n}\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"ServiceRegionId\\": \\"\\",\\n \\"CrossRegionBandwidth\\": 0\\n}","errorExample":""},{"type":"xml","example":"<GetVpcEndpointAttributeResponse>\\n <Payer>Endpoint</Payer>\\n <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>\\n <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>\\n <CreateTime>2021-09-24T18:00:07Z</CreateTime>\\n <ResourceOwner>true</ResourceOwner>\\n <EndpointBusinessStatus>Normal</EndpointBusinessStatus>\\n <EndpointDescription>This is my Endpoint.</EndpointDescription>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <EndpointStatus>Active</EndpointStatus>\\n <VpcId>vpc-fdfhkjafhjvcvdjf****</VpcId>\\n <EndpointName>test</EndpointName>\\n <ZonePrivateIpAddressCount>1</ZonePrivateIpAddressCount>\\n <EndpointType>Interface</EndpointType>\\n <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>\\n <Bandwidth>1024</Bandwidth>\\n <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>\\n <RegionId>cn-huhehaote</RegionId>\\n <ConnectionStatus>Connected</ConnectionStatus>\\n <ZoneAffinityEnabled>true</ZoneAffinityEnabled>\\n</GetVpcEndpointAttributeResponse>","errorExample":""}]', + 'title' => 'GetVpcEndpointAttribute', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpointServicesByEndUser' => [ + 'summary' => 'Queries a list of endpoint services that can be associated with the endpoint created within the current account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16181', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the value to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: **1** to **1000**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint service that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the endpoint service that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****', + ], + ], + [ + 'name' => 'ServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the endpoint service.'."\n" + ."\n" + .'Set the value to **Interface**. You can specify CLB and ALB instances as service resources for the endpoint service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Interface', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region list.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + [ + 'name' => 'ServiceRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Services' => [ + 'description' => 'The information about endpoint services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about endpoint services.'."\n", + 'type' => 'object', + 'properties' => [ + 'Payer' => [ + 'description' => 'The payer. Valid values:'."\n" + ."\n" + .'* **Endpoint**: the service consumer'."\n" + .'* **EndpointService**: the service provider'."\n", + 'type' => 'string', + 'example' => 'Endpoint', + ], + 'ServiceDomain' => [ + 'description' => 'The domain name of the endpoint service that can be associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com', + ], + 'Zones' => [ + 'description' => 'The zones of the endpoint service that can be associated with the endpoint.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote-a', + ], + ], + 'ServiceId' => [ + 'description' => 'The ID of the endpoint service that can be associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceName' => [ + 'description' => 'The name of the endpoint service that can be associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****', + ], + 'ServiceType' => [ + 'description' => 'The type of the endpoint service.'."\n" + ."\n" + .'Only **Interface** is returned, which indicates an interface endpoint. You can specify **CLB** and **ALB** instances as service resources.'."\n", + 'type' => 'string', + 'example' => 'Interface', + ], + 'ServiceSupportIPv6' => [ + 'description' => 'Indicates whether IPv6 is enabled. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Tags' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmy*****', + ], + 'ServiceResourceType' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: Classic Load Balancer (CLB) instance'."\n" + .'* **alb**: Application Load Balancer (ALB) instance'."\n" + .'* **nlb**: Network Load Balancer (NLB) instance'."\n", + 'type' => 'string', + 'example' => 'slb', + ], + 'AddressIpVersion' => [ + 'description' => 'The protocol. Valid values:'."\n" + ."\n" + .'* **IPv4**'."\n" + .'* **DualStack**'."\n", + 'type' => 'string', + 'example' => 'IPv4', + ], + 'ZoneAffinityEnabled' => [ + 'type' => 'boolean', + ], + 'VpcEndpointPolicySupported' => [ + 'type' => 'boolean', + ], + 'AutoAcceptEnabled' => [ + 'type' => 'boolean', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '29', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Services\\": [\\n {\\n \\"Payer\\": \\"Endpoint\\",\\n \\"ServiceDomain\\": \\"epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"Zones\\": [\\n \\"cn-huhehaote-a\\"\\n ],\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceName\\": \\"com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ServiceType\\": \\"Interface\\",\\n \\"ServiceSupportIPv6\\": false,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmy*****\\",\\n \\"ServiceResourceType\\": \\"slb\\",\\n \\"AddressIpVersion\\": \\"IPv4\\",\\n \\"ZoneAffinityEnabled\\": true,\\n \\"VpcEndpointPolicySupported\\": true,\\n \\"AutoAcceptEnabled\\": true\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": \\"29\\"\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointServicesByEndUserResponse>\\n <Services>\\n <Payer>Endpoint</Payer>\\n <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>\\n <Zones>cn-huhehaote-a</Zones>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>\\n <ServiceType>Interface</ServiceType>\\n <ServiceSupportIPv6>false</ServiceSupportIPv6>\\n <Tags>\\n <Key>FinanceDept</Key>\\n <Value>FinanceJoshua</Value>\\n </Tags>\\n </Services>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n</ListVpcEndpointServicesByEndUserResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointServicesByEndUser', + 'description' => "\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableVpcEndpointConnection' => [ + 'summary' => 'Accepts connection requests from an endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '16173', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkDB15J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request is accepted.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the check, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bandwidth of the endpoint connection. Unit: Mbit/s. Valid values: **3072 to 10240**.'."\n" + ."\n" + .'> The bandwidth of an endpoint connection is in the range of **100 to 10,240** Mbit/s. The default bandwidth is **3,072** Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is **3,072 to 10,240** Mbit/s. If Classic Load Balancer (CLB) instances or Application Load Balancer (ALB) instances are specified as service resources, you can modify the endpoint connection bandwidth based on your business requirements. This parameter is invalid if Network Load Balancer (NLB) instances are specified as service resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1024', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request is accepted.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'TrafficControlMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'OperationDenied.NoAvailableServiceResource', + 'errorMessage' => 'The operation is not allowed because of there are no resource in some available zones of endpoint service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableVpcEndpointConnectionResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</EnableVpcEndpointConnectionResponse>","errorExample":""}]', + 'title' => 'EnableVpcEndpointConnection', + 'description' => '* **EnableVpcEndpointConnection** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointAttribute](~~183568~~) operation to query the state of the endpoint connection.'."\n" + ."\n" + .' * If the state is **Connecting**, the endpoint connection is being established.'."\n" + .' * If the state is **Connected**, the endpoint connection is established.'."\n" + ."\n" + .'* You cannot repeatedly call the **EnableVpcEndpointConnection** operation to allow an endpoint service of an Alibaba Cloud account to accept a connection request from an endpoint within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateVpcEndpointConnectionAttribute' => [ + 'summary' => 'Modifies the attributes of an endpoint connection.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkO25BLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection whose bandwidth you want to modify. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bandwidth of the endpoint connection that you want to modify. Unit: Mbit/s. Valid values: **3072** to **10240**.'."\n" + ."\n" + .'> The bandwidth of an endpoint connection is in the range of **100** to **10,240** Mbit/s. The default bandwidth is **3,072** Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is **3,072** to **10,240** Mbit/s. If Classic Load Balancer (CLB) instances or Application Load Balancer (ALB) instances are specified as service resources, you can modify the endpoint connection bandwidth based on your business requirements. This parameter is invalid if Network Load Balancer (NLB) instances are specified as service resources.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection whose bandwidth you want to modify. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'TrafficControlMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'OperationDenied.VpcNatServiceResourceTypeNotSupportBandwidth', + 'errorMessage' => 'The operation is not allowed because of VpcNatServiceResourceTypeNotSupportBandwidth.', + ], + [ + 'errorCode' => 'UpdateBandWidthUnSupported', + 'errorMessage' => 'Bandwidth updates are not supported for this service.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVpcEndpointConnectionAttributeResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</UpdateVpcEndpointConnectionAttributeResponse>","errorExample":""}]', + 'title' => 'UpdateVpcEndpointConnectionAttribute', + 'description' => 'You cannot repeatedly call the **UpdateVpcEndpointConnectionAttribute** operation to modify the bandwidth of an endpoint connection that belongs to an Alibaba Cloud account within a specified period of time.'."\n", + ], + 'ListVpcEndpointConnections' => [ + 'summary' => 'Queries endpoint connections.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkO25BLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the value to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **1** to **50**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EniId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint elastic network interface (ENI).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eni-hp32lk0pyv6o94hs****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'ConnectionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The endpoint connection is being modified.'."\n" + .'* **Connecting**: The endpoint connection is being established.'."\n" + .'* **Connected**: The endpoint connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The connection is being deleted.'."\n" + .'* **ServiceDeleted**: The corresponding endpoint service has been deleted.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Disconnected', + ], + ], + [ + 'name' => 'EndpointOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the endpoint belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '25346073170691****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'ReplacedResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the replaced service resource in smooth migration scenarios.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the endpoint belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmy*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Connections' => [ + 'description' => 'The endpoint connections.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Zones' => [ + 'description' => 'The zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'vsw-hp3uf6045ljdhd5zr****', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote-b', + ], + 'ResourceId' => [ + 'description' => 'The service resource ID.'."\n", + 'type' => 'string', + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + 'EniId' => [ + 'description' => 'The endpoint ENI ID.'."\n", + 'type' => 'string', + 'example' => 'eni-hp32lk0pyv6o94hs****', + ], + 'ZoneDomain' => [ + 'description' => 'The domain name of the zone.'."\n", + 'type' => 'string', + 'example' => 'ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com', + ], + 'ZoneStatus' => [ + 'description' => 'The state of the zone. Valid values:'."\n" + ."\n" + .'* **Creating**: The zone is being created.'."\n" + .'* **Wait**: The zone is to be connected.'."\n" + .'* **Connected**: The zone is connected.'."\n" + .'* **Deleting**: The zone is being deleted.'."\n" + .'* **Disconnecting**: The zone is being disconnected.'."\n" + .'* **Disconnected**: The zone is disconnected.'."\n" + .'* **Connecting**: The zone is being connected.'."\n" + .'* **Migrating**: The zone is being migrated.'."\n" + .'* **Migrated**: The zone is migrated.'."\n", + 'type' => 'string', + 'example' => 'Connected', + ], + 'ReplacedResourceId' => [ + 'description' => 'The ID of the replaced service resource in smooth migration scenarios.'."\n", + 'type' => 'string', + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + 'ReplacedEniId' => [ + 'description' => 'The ID of the replaced endpoint ENI in smooth migration scenarios.'."\n", + 'type' => 'string', + 'example' => 'eni-hp32lk0pyv6o94hs****', + ], + ], + ], + ], + 'ModifiedTime' => [ + 'description' => 'The time when the endpoint connection was modified.'."\n", + 'type' => 'string', + 'example' => '2021-09-28T10:34:46Z', + ], + 'Bandwidth' => [ + 'description' => 'The bandwidth of the endpoint connection. Valid values: **1024 to 10240**. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'EndpointOwnerId' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the endpoint belongs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25346073170691****', + ], + 'ResourceOwner' => [ + 'description' => 'Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + 'ConnectionStatus' => [ + 'description' => 'The state of the endpoint connection. Valid values:'."\n" + ."\n" + .'* **Pending**: The connection is being modified.'."\n" + .'* **Connecting**: The connection is being established.'."\n" + .'* **Connected**: The connection is established.'."\n" + .'* **Disconnecting**: The endpoint is being disconnected from the endpoint service.'."\n" + .'* **Disconnected**: The endpoint is disconnected from the endpoint service.'."\n" + .'* **Deleting**: The connection is being deleted.'."\n" + .'* **ServiceDeleted**: The corresponding endpoint service has been deleted.'."\n", + 'type' => 'string', + 'example' => 'Disconnected', + ], + 'EndpointId' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****', + ], + 'EndpointVpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-hp356stwkxg3fn2xe****', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the endpoint belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmw353z35v***', + ], + 'TrafficControlMode' => [ + 'type' => 'string', + ], + 'EndpointRegionId' => [ + 'type' => 'string', + ], + 'ServiceRegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Connections\\": [\\n {\\n \\"Zones\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-hp3uf6045ljdhd5zr****\\",\\n \\"ZoneId\\": \\"cn-huhehaote-b\\",\\n \\"ResourceId\\": \\"lb-hp32z1wp5peaoox2q****\\",\\n \\"EniId\\": \\"eni-hp32lk0pyv6o94hs****\\",\\n \\"ZoneDomain\\": \\"ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com\\",\\n \\"ZoneStatus\\": \\"Connected\\",\\n \\"ReplacedResourceId\\": \\"lb-hp32z1wp5peaoox2q****\\",\\n \\"ReplacedEniId\\": \\"eni-hp32lk0pyv6o94hs****\\"\\n }\\n ],\\n \\"ModifiedTime\\": \\"2021-09-28T10:34:46Z\\",\\n \\"Bandwidth\\": 3072,\\n \\"EndpointOwnerId\\": 0,\\n \\"ResourceOwner\\": true,\\n \\"ServiceId\\": \\"epsrv-hp3vpx8yqxblby3i****\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"EndpointId\\": \\"ep-hp33b2e43fays7s8****\\",\\n \\"EndpointVpcId\\": \\"vpc-hp356stwkxg3fn2xe****\\",\\n \\"ResourceGroupId\\": \\"rg-acfmw353z35v***\\",\\n \\"TrafficControlMode\\": \\"\\",\\n \\"EndpointRegionId\\": \\"\\",\\n \\"ServiceRegionId\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointConnectionsResponse>\\n <Connections>\\n <ResourceOwner>true</ResourceOwner>\\n <Zones>\\n <VSwitchId>vsw-hp3uf6045ljdhd5zr****</VSwitchId>\\n <ZoneId>cn-huhehaote-b</ZoneId>\\n <ResourceId>lb-hp32z1wp5peaoox2q****</ResourceId>\\n <EniId>eni-hp32lk0pyv6o94hs****</EniId>\\n <ZoneDomain>ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com</ZoneDomain>\\n <ZoneStatus>Connected</ZoneStatus>\\n <ReplacedResourceId>lb-hp32z1wp5peaoox2q****</ReplacedResourceId>\\n <ReplacedEniId>eni-hp32lk0pyv6o94hs****</ReplacedEniId>\\n <ConnectionId>123</ConnectionId>\\n <ConnectionStringId>12345</ConnectionStringId>\\n </Zones>\\n <ModifiedTime>2021-09-28T10:34:46Z</ModifiedTime>\\n <Bandwidth>1024</Bandwidth>\\n <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>\\n <ConnectionStatus>Disconnected</ConnectionStatus>\\n <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>\\n <EndpointVpcId>vpc-hp356stwkxg3fn2xe****</EndpointVpcId>\\n </Connections>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n</ListVpcEndpointConnectionsResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointConnections', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableVpcEndpointConnection' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request from the endpoint is rejected. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request from the endpoint is rejected. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableVpcEndpointConnectionResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</DisableVpcEndpointConnectionResponse>","errorExample":""}]', + 'title' => 'DisableVpcEndpointConnection', + 'summary' => 'Rejects a connection request from an endpoint.', + 'description' => '* **DisableVpcEndpointConnection** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointAttribute](~~183568~~) operation to query the state of the endpoint connection.'."\n" + ."\n" + .' * If the endpoint connection is in the **Disconnecting** state, the endpoint is being disconnected from the endpoint service.'."\n" + .' * If the endpoint connection is in the **Disconnected** state, the endpoint is disconnected from the endpoint service.'."\n" + ."\n" + .'* You cannot repeatedly call the **DisableVpcEndpointConnection** operation to allow an endpoint service to reject a connection request from an endpoint within a specified period of time.'."\n", + ], + 'AddZoneToVpcEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '16161', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkGBNC0X', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone that you want to add.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch in the zone that you want to add. The system automatically creates an endpoint ENI in the vSwitch.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-hjkshjvdkdvd****', + ], + ], + [ + 'name' => 'ip', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP address of the endpoint elastic network interface (ENI) in the zone that you want to add.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.XX.XX.32', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint to which you want to add the zone.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ipv6Address', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IPv6 address of the endpoint ENI in the zone that you want to add.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2408:4005:3b6:****:6955:c3cb:34c:****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.EndpointProtected', + 'errorMessage' => 'The operation is not allowed because of EndpointProtected.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointZoneDuplicated', + 'errorMessage' => 'The zone is duplicated for the Endpoint.', + ], + [ + 'errorCode' => 'EndpointServiceNotSupportedZone', + 'errorMessage' => 'The specified endpoint service does not support the zone.', + ], + [ + 'errorCode' => 'QuotaMisMatched', + 'errorMessage' => 'The resource you applied for has exceeded the quota.', + ], + [ + 'errorCode' => 'EndpointDuplicated', + 'errorMessage' => 'The endpoint of the service already exists and cannot be created again.', + ], + [ + 'errorCode' => 'EndpointServiceDeleted', + 'errorMessage' => 'The specified Service is already deleted.', + ], + [ + 'errorCode' => 'EndpointServiceResourceNotFound', + 'errorMessage' => 'The specified service resource is not found.', + ], + [ + 'errorCode' => 'VSwitchNotFound', + 'errorMessage' => 'The specified VSwitch does not exist.', + ], + [ + 'errorCode' => 'EniIpUnavailable', + 'errorMessage' => 'The specified IP address is unavailable.', + ], + [ + 'errorCode' => 'EndpointProtected', + 'errorMessage' => 'The specified Endpoint is protected.', + ], + [ + 'errorCode' => 'VSwitchStatusNotAllowed', + 'errorMessage' => 'The specified vswitch status is not Available.', + ], + [ + 'errorCode' => 'VpcNatServiceException', + 'errorMessage' => 'The vpcNat service is busy', + ], + [ + 'errorCode' => 'ResourceNotEnough.VSwitchIp', + 'errorMessage' => 'The specified resource of VSwitchIp is not enough.', + ], + [ + 'errorCode' => 'OperationDenied.VSwitchNotSupportDualstack', + 'errorMessage' => 'The specified VSwitch does not support dualstack.', + ], + [ + 'errorCode' => 'OperationDenied.AddressIpVersionNotSupportSpecifyIpv6', + 'errorMessage' => 'The AddressIpVersion of the endpoint does not support specifying IPv6 address.', + ], + [ + 'errorCode' => 'IllegalParam.Ip', + 'errorMessage' => 'The specified parameter IP is invalid.', + ], + [ + 'errorCode' => 'IllegalParam.Ipv6Address', + 'errorMessage' => 'The specified parameter Ipv6Address is invalid.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0c593ea1-3bea-11e9-b96b-88e9fe637760\\"\\n}","errorExample":""},{"type":"xml","example":"<AddZoneToVpcEndpointResponse>\\n <RequestId>0c593ea1-3bea-11e9-b96b-88e9fe637760</RequestId>\\n</AddZoneToVpcEndpointResponse>","errorExample":""}]', + 'title' => 'AddZoneToVpcEndpoint', + 'summary' => 'Adds a zone to an endpoint.', + 'description' => '* **AddZoneToVpcEndpoint** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpointZones](~~183560~~) operation to query the state of the zone.'."\n" + ."\n" + .' * If the zone is in the **Creating** state, the zone is being added.'."\n" + .' * If the zone is in the Wait state, the zone is added.'."\n" + ."\n" + .'* You cannot repeatedly call the **AddZoneToVpcEndpoint** operation to add a zone to an endpoint within a specified period of time.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVpcEndpointZones' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **1** to **50**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint for which you want to query zones.'."\n" + ."\n" + .'After you specify an endpoint ID, the system queries the zones of the specified endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Zones' => [ + 'description' => 'The information about the zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch in the zone. The system automatically creates an endpoint elastic network interface (ENI) in the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-hjkshjvdkdvd****', + ], + 'EniIp' => [ + 'description' => 'The IP address of the endpoint ENI.'."\n", + 'type' => 'string', + 'example' => '192.168.2.23', + ], + 'ZoneStatus' => [ + 'description' => 'The state of the zone. Valid values:'."\n" + ."\n" + .'* **Creating**: The zone is being created.'."\n" + .'* **Wait**: The zone is to be connected.'."\n" + .'* **Connected**: The zone is connected.'."\n" + .'* **Deleting**: The zone is being deleted.'."\n" + .'* **Disconnecting**: The zone is being disconnected.'."\n" + .'* **Disconnected**: The zone is disconnected.'."\n" + .'* **Connecting**: The zone is being connected.'."\n", + 'type' => 'string', + 'example' => 'Wait', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote-a', + ], + 'EniId' => [ + 'description' => 'The ID of the endpoint ENI.'."\n", + 'type' => 'string', + 'example' => 'eni-hp3c8qj1tyct8aqy****', + ], + 'ZoneDomain' => [ + 'description' => 'The domain name of the zone.'."\n" + ."\n" + .'After the endpoint in the zone is connected to the endpoint service, you can access the service resources of the endpoint service by using the domain name of the zone.'."\n", + 'type' => 'string', + 'example' => 'ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => 'The region ID of the endpoint.'."\n", + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + 'ZoneIpv6Address' => [ + 'description' => 'Indicates whether the endpoint service supports IPv6. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": 12,\\n \\"Zones\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-hjkshjvdkdvd****\\",\\n \\"EniIp\\": \\"192.168.2.23\\",\\n \\"ZoneStatus\\": \\"Wait\\",\\n \\"ZoneId\\": \\"cn-huhehaote-a\\",\\n \\"EniId\\": \\"eni-hp3c8qj1tyct8aqy****\\",\\n \\"ZoneDomain\\": \\"ep-hp3f033dp24c5yc9****-cn-huhehaote-a.epsrv-hp3itcpowf37m3d5****.cn-huhehaote.privatelink.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-huhehaote\\",\\n \\"ZoneIpv6Address\\": \\"2408:4005:3b6:****:6955:c3cb:34c:****\\\\n\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointZonesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n <Zones>\\n <VSwitchId>vsw-hjkshjvdkdvd****</VSwitchId>\\n <EniIp>192.168.2.23</EniIp>\\n <ZoneStatus>Wait</ZoneStatus>\\n <ZoneId>cn-huhehaote-a</ZoneId>\\n <ServiceStatus>Active</ServiceStatus>\\n <EniId>eni-hp3c8qj1tyct8aqy****</EniId>\\n <ZoneDomain>ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com</ZoneDomain>\\n <RegionId>cn-huhehaote</RegionId>\\n <ZoneIpv6Address>false</ZoneIpv6Address>\\n </Zones>\\n</ListVpcEndpointZonesResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointZones', + 'summary' => 'Queries the zones of an endpoint.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveZoneFromVpcEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '16186', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkGBNC0X', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint for which you want to delete the zone. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1a', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint for which you want to delete the zone.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint for which you want to delete the zone. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.EndpointProtected', + 'errorMessage' => 'The operation is not allowed because of EndpointProtected.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointZoneNotFound', + 'errorMessage' => 'The specified zone of Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointProtected', + 'errorMessage' => 'The specified Endpoint is protected.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerZoneCountDeny', + 'errorMessage' => 'The GatewayLoadBalancer zone count not support', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0c593ea1-3bea-11e9-b96b-88e9fe637760\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveZoneFromVpcEndpointResponse>\\n <RequestId>0c593ea1-3bea-11e9-b96b-88e9fe637760</RequestId>\\n</RemoveZoneFromVpcEndpointResponse>","errorExample":""}]', + 'title' => 'RemoveZoneFromVpcEndpoint', + 'summary' => 'Deletes a zone of an endpoint.', + 'description' => '* **RemoveZoneFromVpcEndpoint** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpointZones](~~183560~~) operation to check whether the zone of the endpoint is deleted.'."\n" + ."\n" + .' * If the zone of the endpoint is in the **Deleting** state, the zone is being deleted.'."\n" + .' * If the zone cannot be queried, the zone is deleted.'."\n" + ."\n" + .'* You cannot repeatedly call the **RemoveZoneFromVpcEndpoint** operation to delete a zone of an endpoint within a specified period of time.'."\n", + ], + 'DisableVpcEndpointZoneConnection' => [ + 'summary' => 'Closes connections in an endpoint zone.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '34070', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkDB15J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request from the endpoint is rejected.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone that is associated with the endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ReplacedResource', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to close connections in the endpoint zone after migration. Valid values:'."\n" + ."\n" + .'* **true**: yes'."\n" + .'* **false** (default): no'."\n" + ."\n" + .'> Set the value to true if you want to close connections in the endpoint zone after migration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the connection request from the endpoint is rejected.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'IncorrectBusinessStatus.VpcEndpoint', + 'errorMessage' => 'The business status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectBusinessStatus.VpcEndpointService', + 'errorMessage' => 'The business status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpoint', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointConnection', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointService', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointZone', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportZoneConnection', + 'errorMessage' => 'The gateway load balancer not support zone connection.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.VpcEndpoint', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointConnection', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointService', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointZone', + 'errorMessage' => 'The specified resource %s is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableVpcEndpointZoneConnectionResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</DisableVpcEndpointZoneConnectionResponse>","errorExample":""}]', + 'title' => 'DisableVpcEndpointZoneConnection', + 'description' => '* You can call this operation only when the state of the endpoint is **Connected** and the state of the zone associated with the endpoint is **Connected** or **Migrated**.'."\n" + ."\n" + .'* **DisableVpcEndpointZoneConnection** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpointZones](~~183560~~) operation to query the status of the task.'."\n" + ."\n" + .' * If the zone is in the **Disconnecting** state, the task is running.'."\n" + .' * If the zone is in the **Disconnected** state, the task is successful.'."\n" + ."\n" + .'* You cannot repeatedly call the **DisableVpcEndpointZoneConnection** operation to allow an endpoint service to reject a connection request from the endpoint in the zone within a specified period of time.'."\n", + ], + 'EnableVpcEndpointZoneConnection' => [ + 'summary' => 'Allows connections to endpoint zones.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '34068', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkDB15J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the endpoint connection request is accepted. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone that is associated with the endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the endpoint connection request is accepted. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'IncorrectBusinessStatus.VpcEndpoint', + 'errorMessage' => 'The business status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectBusinessStatus.VpcEndpointService', + 'errorMessage' => 'The business status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpoint', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointConnection', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointService', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'IncorrectStatus.VpcEndpointZone', + 'errorMessage' => 'The status of %s [%s] is incorrect.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportZoneConnection', + 'errorMessage' => 'The gateway load balancer not support zone connection.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.VpcEndpoint', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointConnection', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointService', + 'errorMessage' => 'The specified resource %s is not found.', + ], + [ + 'errorCode' => 'ResourceNotFound.VpcEndpointZone', + 'errorMessage' => 'The specified resource %s is not found.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","type":"json"}]', + 'title' => 'EnableVpcEndpointZoneConnection', + 'description' => '* You can call this operation only when the state of the endpoint is **Connected** and the state of the associated zone is **Disconnected**.'."\n" + ."\n" + .'* **EnableVpcEndpointZoneConnection** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpointZones](~~183560~~) operation to check whether the endpoint service accepts a connection request from the endpoint in the associated zone.'."\n" + ."\n" + .' * If the zone is in the **Connecting** state, the endpoint service is accepting the connection request from the endpoint.'."\n" + .' * If the zone is in the **Connected** state, the endpoint service has accepted the connection request from the endpoint.'."\n" + ."\n" + .'* You cannot repeatedly call the **EnableVpcEndpointZoneConnection** operation to allow an endpoint service to accept a connection request from an endpoint in the associated zone within a specified period of time.'."\n", + ], + 'UpdateVpcEndpointZoneConnectionResourceAttribute' => [ + 'summary' => 'Modifies a service resource of a zone to which an endpoint connection belongs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '32983', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkO25BLH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection whose bandwidth you want to modify.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint service ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'epsrv-hp3vpx8yqxblby3i****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ResourceAllocateMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource allocation mode. You can change the resource allocation mode only if the endpoint connection is in the **Disconnected** state. Valid values:'."\n" + ."\n" + .'* **Auto**: automatically and randomly allocates service resources. In this mode, the specified service resource is deleted.'."\n" + .'* **Manual**: manually allocates service resources. If you set the value to Manual, you must also specify the **ResourceId** and **ResourceType** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Auto', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceReplaceMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The migration mode of the service resource. Valid values:'."\n" + ."\n" + .'* **Graceful**: smooth migration. Service resources in the zone are smoothly migrated.'."\n" + .'* **Force**: forced migration. Service resources in the zone are forcefully migrated.'."\n" + ."\n" + .'> You need to specify this parameter only if you want to migrate service resources and the endpoint connection is in the **Connected** state. If you specify this parameter, you must also specify the **ResourceId** and **ResourceType** parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Graceful', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the service resource. Valid values:'."\n" + ."\n" + .'* **slb**: a CLB instance that supports PrivateLink. In addition, the CLB instance is deployed in a VPC.'."\n" + .'* **alb**: an Application Load Balancer (ALB) instance that supports PrivateLink. In addition, the ALB instance is deployed in a VPC.'."\n" + ."\n" + .'> If **ResourceAllocateMode** is set to **Mannual**, or **ResourceReplaceMode** is set, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slb', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the service resource that you want to manually allocate or migrate in the zone where the endpoint connection is deployed.'."\n" + ."\n" + .'> If **ResourceAllocateMode** is set to **Mannual**, or **ResourceReplaceMode** is set, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint connection whose bandwidth you want to modify.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointServiceNotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionNotFound', + 'errorMessage' => 'The specified endpoint connection does not exist.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceLocked', + 'errorMessage' => 'The specified Service is locked.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointZoneNotFound', + 'errorMessage' => 'The specified zone of Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointServiceResourceTypeNotSupport', + 'errorMessage' => 'The specified resource type is not supported.', + ], + [ + 'errorCode' => 'EndpointServiceResourceNotFound', + 'errorMessage' => 'The specified service resource is not found.', + ], + [ + 'errorCode' => 'ZoneOperationDenied', + 'errorMessage' => 'You cannot operate the specified zone.', + ], + [ + 'errorCode' => 'IllegalParam.ResourceAllocateMode', + 'errorMessage' => 'The param of %s is illegal.', + ], + [ + 'errorCode' => 'IllegalParam.ResourceReplaceMode', + 'errorMessage' => 'The param of %s is illegal.', + ], + [ + 'errorCode' => 'MissingParam.ResourceId', + 'errorMessage' => 'The param of %s is missing.', + ], + [ + 'errorCode' => 'MissingParam.ResourceAllocateMode', + 'errorMessage' => 'The param of %s is missing.', + ], + [ + 'errorCode' => 'OperationDenied.CurrentResourceAutoAllocated', + 'errorMessage' => 'The operation is not allowed because of CurrentResourceAutoAllocated.', + ], + [ + 'errorCode' => 'Mismatch.ZoneId', + 'errorMessage' => 'The %s is mismatched for %s and %s.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportZoneConnection', + 'errorMessage' => 'The gateway load balancer not support zone connection.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateVpcEndpointZoneConnectionResourceAttributeResponse>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</UpdateVpcEndpointZoneConnectionResourceAttributeResponse>","errorExample":""}]', + 'title' => 'UpdateVpcEndpointZoneConnectionResourceAttribute', + 'description' => '### Prerequisites'."\n" + ."\n" + .'By default, the feature of modifying a service resource of a zone to which an endpoint connection belongs is unavailable. To use this feature, log on to the [Quota Center console](https://quotas.console.aliyun.com/white-list-products/privatelink/quotas). Click Whitelist Quotas in the left-side navigation pane and click PrivateLink in the Networking section. On the page that appears, search for `privatelink_whitelist/svc_res_mgt_uat` and click Apply in the Actions column.'."\n" + ."\n" + .'### Usage notes'."\n" + ."\n" + .'* If the endpoint connection is in the **Disconnected** state, you can manually allocate the service resource in the zone.'."\n" + ."\n" + .'* If the endpoint connection is in the **Connected** state, you can manually migrate the service resource in the zone. In this case, the connection might be interrupted.'."\n" + ."\n" + .'* **UpdateVpcEndpointZoneConnectionResourceAttribute** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [GetVpcEndpointServiceAttribute](~~469330~~) operation to check whether the service resource is modified.'."\n" + ."\n" + .' * If the endpoint service is in the **Pending** state, the service resource is being modified.'."\n" + .' * If the endpoint service is in the **Active** state, the service resource is modified.'."\n" + ."\n" + .'* You cannot repeatedly call the **UpdateVpcEndpointZoneConnectionResourceAttribute** operation to modify a service resource in the zone to which an endpoint connection belongs within a specified period of time.'."\n", + ], + 'AttachSecurityGroupToVpcEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '16163', + 'abilityTreeNodes' => [ + 'FEATUREprivatelink57DP0F', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint with which you want to associate with the security group. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group with which you want to associate the endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-hp3c8qj1tyct90ej****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint with which you want to associate the security group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint with which you want to associate with the security group. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D778FF9-7640-4C13-BCD6-9265CA9A2F81', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'SecurityGroupExist', + 'errorMessage' => 'The specified security group already exists.', + ], + [ + 'errorCode' => 'EndpointServiceDeleted', + 'errorMessage' => 'The specified Service is already deleted.', + ], + [ + 'errorCode' => 'SecurityGroupNotFound', + 'errorMessage' => 'The specified security group does not exist.', + ], + [ + 'errorCode' => 'SecurityGroupTypeNotSupport', + 'errorMessage' => 'The specified security group type is not supported.', + ], + [ + 'errorCode' => 'SecurityGroupTypeOnlySingleTypeSupporteded', + 'errorMessage' => 'The specified security group only support one type.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportSecurityGroup', + 'errorMessage' => 'The gateway load balancer not support security group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D778FF9-7640-4C13-BCD6-9265CA9A2F81\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachSecurityGroupToVpcEndpointResponse>\\n <RequestId>8D778FF9-7640-4C13-BCD6-9265CA9A2F81</RequestId>\\n</AttachSecurityGroupToVpcEndpointResponse>","errorExample":""}]', + 'title' => 'AttachSecurityGroupToVpcEndpoint', + 'summary' => 'Associates an endpoint with a security group.', + 'description' => '* **AttachSecurityGroupToVpcEndpoint** is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpoints](~~183558~~) operation to query the state of the endpoint.'."\n" + ."\n" + .' * If the endpoint is in the **Pending** state, the endpoint is being associated with the security group.'."\n" + .' * If the endpoint is in the **Active** state, the endpoint is associated with the security group.'."\n" + ."\n" + .'* You cannot repeatedly call the **AttachSecurityGroupToVpcEndpoint** operation to associate an endpoint with a security group within a specified period of time.'."\n", + ], + 'ListVpcEndpointSecurityGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of **NextToken** that is returned from the last call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values:**1** to **50**. Default value: **50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '0', + 'example' => '50', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to query.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-huhehaote', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroups' => [ + 'description' => 'The information about the security groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group that is associated with the endpoint.'."\n", + 'type' => 'string', + 'example' => 'sg-hp33bw6ynvm2yb0e****', + ], + 'SecurityGroupStatus' => [ + 'description' => 'The associate status of the security group, valid values:'."\n" + .'- Attaching: The security group is being attached.'."\n" + .'- Attached: The security group is attached.'."\n" + .'- Detaching: The security group is being detached.', + 'type' => 'string', + 'example' => 'Attached', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If no value is returned for **NextToken**, no next requests are performed.'."\n" + .'* If a value is returned for **NextToken**, the value can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + 'MaxResults' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-hp33bw6ynvm2yb0e****\\",\\n \\"SecurityGroupStatus\\": \\"Attached\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\",\\n \\"MaxResults\\": 50,\\n \\"TotalCount\\": 12\\n}","errorExample":""},{"type":"xml","example":"<ListVpcEndpointSecurityGroupsResponse>\\n <SecurityGroups>\\n <SecurityGroupId>sg-hp33bw6ynvm2yb0e****</SecurityGroupId>\\n </SecurityGroups>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n <MaxResults>50</MaxResults>\\n</ListVpcEndpointSecurityGroupsResponse>","errorExample":""}]', + 'title' => 'ListVpcEndpointSecurityGroups', + 'summary' => 'Queries the security group that is associated with an endpoint.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachSecurityGroupFromVpcEndpoint' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to disassociate from the security group. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group from which you want to disassociate the endpoint.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-hp3c8qj1tyct90ej****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the endpoint that you want to disassociate from the security group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ep-hp33b2e43fays7s8****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the endpoint that you want to disassociate from the security group. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'eu-west-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D778FF9-7640-4C13-BCD6-9265CA9A2F81', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityGroupNotFound', + 'errorMessage' => 'The specified security group does not exist.', + ], + [ + 'errorCode' => 'EndpointMustContainSecurityGroup', + 'errorMessage' => 'The specified endpoint must have at least one security group.', + ], + [ + 'errorCode' => 'EndpointNotFound', + 'errorMessage' => 'The specified Endpoint does not exist.', + ], + [ + 'errorCode' => 'EndpointOperationDenied', + 'errorMessage' => 'The specified operation of endpoint is not allowed.', + ], + [ + 'errorCode' => 'EndpointLocked', + 'errorMessage' => 'The specified Endpoint is locked.', + ], + [ + 'errorCode' => 'EndpointConnectionOperationDenied', + 'errorMessage' => 'The endpoint is being connected.', + ], + [ + 'errorCode' => 'EndpointServiceDeleted', + 'errorMessage' => 'The specified Service is already deleted.', + ], + [ + 'errorCode' => 'GatewayLoadBalancerNotSupportSecurityGroup', + 'errorMessage' => 'The gateway load balancer not support security group.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D778FF9-7640-4C13-BCD6-9265CA9A2F81\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachSecurityGroupFromVpcEndpointResponse>\\n <RequestId>8D778FF9-7640-4C13-BCD6-9265CA9A2F81</RequestId>\\n</DetachSecurityGroupFromVpcEndpointResponse>","errorExample":""}]', + 'title' => 'DetachSecurityGroupFromVpcEndpoint', + 'summary' => 'Disassociates an endpoint from a security group.', + 'description' => '* **DetachSecurityGroupFromVpcEndpoint** is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the [ListVpcEndpoints](~~183558~~) to check whether the endpoint is disassociated from the security group.'."\n" + ."\n" + .' * If the endpoint is in the **Pending** state, the endpoint is being disassociated from the security group.'."\n" + .' * If you cannot query the endpoint in the security group, the endpoint is disassociated from the security group.'."\n" + ."\n" + .'* You cannot repeatedly call the **DetachSecurityGroupFromVpcEndpoint** operation to disassociate an endpoint from a security group within a specified period of time.'."\n", + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from one or more endpoints or endpoint services at a time.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkW2XK1B', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-hp32z1wp5peaoox2q****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The keys of the tags that you want to remove from the resources. You can specify up to 20 tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag that you want to remove from the resource. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The tag key must start with a letter but cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'* **vpcendpoint**: endpoint'."\n" + .'* **vpcendpointservice**: endpoint service'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'slb', + ], + ], + [ + 'name' => 'All', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from the resource. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> If you specify both the All and TagKey.N parameters, the All parameter does not take effect.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a `2xx HTTP` status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n" + ."\n" + .'> If you do not specify this parameter, the system automatically uses the request ID as the client token.******** The request ID may be different for each request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the PrivateLink instance.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the PrivateLink instance.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TagInfoNotExist', + 'errorMessage' => 'Tag info not exist', + ], + [ + 'errorCode' => 'DuplicatedTagKey', + 'errorMessage' => 'The tag keys is duplicated.', + ], + [ + 'errorCode' => 'IllegalTagKeyParam', + 'errorMessage' => 'IllegalTagKeyParam', + ], + [ + 'errorCode' => 'IllegalTagValueParam', + 'errorMessage' => 'The tag value is Illegal.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are added to resources.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ep-hp3i05294c2d2d******', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* **vpcendpoint**: endpoint'."\n" + .'* **vpcendpointservice**: endpoint service'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpcendpoint', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags to add to the resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags to add to the resource.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The tag key must start with a letter but cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The tag value must start with a letter but cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0c593ea1-3bea-11e9-b96b-88e9fe637760', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the resource resides. You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'* If this is your first request or no next requests are to be sent, you do not need to specify this parameter.'."\n" + .'* If a next request is to be sent, you must specify the token that is obtained from the previous request as the value of **NextToken**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + 'TagResources' => [ + 'description' => 'The resources to which the tags are added.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resources to which the tags are added.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The key of tag N added to the resource.'."\n", + 'type' => 'string', + 'example' => 'endpoint', + ], + 'TagValue' => [ + 'description' => 'The value of tag N added to the resource.'."\n", + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'ep-hp3i05294c2d2d******', + ], + 'ResourceType' => [ + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* **vpcendpoint**: endpoint'."\n" + .'* **vpcendpointservice**: endpoint service'."\n", + 'type' => 'string', + 'example' => 'vpcendpoint', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n" + ."\n" + .'* If this is your first request and no next requests are to be performed, you do not need to specify this parameter.'."\n" + .'* If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DuplicatedTagKey', + 'errorMessage' => 'The tag keys is duplicated.', + ], + [ + 'errorCode' => 'MissingTagKeyParam', + 'errorMessage' => 'The tag key is empty.', + ], + [ + 'errorCode' => 'MissingTagValueParam', + 'errorMessage' => 'The tag value is empty.', + ], + [ + 'errorCode' => 'MissingResourceIdOrTagParam', + 'errorMessage' => 'The resource id and tag is empty.', + ], + [ + 'errorCode' => 'IllegalTagKeyParam', + 'errorMessage' => 'IllegalTagKeyParam', + ], + [ + 'errorCode' => 'IllegalTagValueParam', + 'errorMessage' => 'The tag value is Illegal.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"endpoint\\",\\n \\"TagValue\\": \\"FinanceJoshua\\",\\n \\"ResourceId\\": \\"ep-hp3i05294c2d2d******\\",\\n \\"ResourceType\\": \\"vpcendpoint\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","type":"json"}]', + 'title' => 'ListTagResources', + 'description' => '* You must specify **ResourceId.N** or **Tag.N** in the request to specify the object that you want to query.'."\n" + .'* **Tag.N** is a resource tag that consists of a key-value pair (Tag.N.Key and Tag.N.Value). If you specify only **Tag.N.Key**, all tag values that are associated with the specified key are returned. If you specify only **Tag.N.Value**, an error message is returned.'."\n" + .'* If you specify **Tag.N** and **ResourceId.N** to filter tags, **ResourceId.N** must match all specified key-value pairs.'."\n" + .'* If you specify multiple key-value pairs, resources that contain these key-value pairs are returned.', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to resources. You can call this API operation to add tags to one or more endpoints or endpoint services.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The resource IDs. Up to 50 resource IDs are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'lb-bp16qjewdsunr41m1****', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The tags to add to the resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => 'The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n" + ."\n" + .'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of resource. Valid values:'."\n" + ."\n" + .'* **vpcendpoint**: endpoint'."\n" + .'* **vpcendpointservice**: endpoint service'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" + ."\n" + .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n" + .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" + ."\n" + .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n" + ."\n" + .'> If you do not specify this parameter, the system automatically uses the request ID as the client token.******** The request ID may be different for each request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The region ID of the PrivateLink instance.'."\n" + ."\n" + .'You can call the [DescribeRegions](~~120468~~) operation to query the most recent region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C46FF5A8-C5F0-4024-8262-B16B639225A0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTagKeyParam', + 'errorMessage' => 'The tag key is empty.', + ], + [ + 'errorCode' => 'MissingTagValueParam', + 'errorMessage' => 'The tag value is empty.', + ], + [ + 'errorCode' => 'IllegalTagKeyParam', + 'errorMessage' => 'IllegalTagKeyParam', + ], + [ + 'errorCode' => 'IllegalTagValueParam', + 'errorMessage' => 'The tag value is Illegal.', + ], + [ + 'errorCode' => 'DuplicatedTagKey', + 'errorMessage' => 'The tag keys is duplicated.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C46FF5A8-C5F0-4024-8262-B16B639225A0\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + 'description' => '> You can add up to 20 tags to an instance. Before you add tags to a resource, Alibaba Cloud checks the number of existing tags of the resource. If the maximum number is reached, an error message is returned.'."\n", + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Modifies a resource group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREprivatelinkEUMK18', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The type of resource. Valid values:'."\n" + ."\n" + .'* **VpcEndpoint**: endpoint'."\n" + .'* **VpcEndpointService**: endpoint service', + 'type' => 'string', + 'required' => false, + 'example' => 'VpcEndpoint', + 'default' => 'VpcEndpoint', + 'enum' => [ + 'vpcendpoint', + 'vpcendpointservice', + ], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ep-hp3i05294c2d2d****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmy*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D8992C1-6712-423C-BAC5-E5E817484C6B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D8992C1-6712-423C-BAC5-E5E817484C6B\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'privatelink.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'privatelink.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'privatelink.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'privatelink.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'privatelink.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'privatelink.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'privatelink.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'privatelink.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'privatelink.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'privatelink.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'privatelink.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'privatelink.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'privatelink.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'privatelink.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'privatelink.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'privatelink.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'privatelink.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'privatelink.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'privatelink.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'privatelink.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'privatelink.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'privatelink.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'privatelink.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'privatelink.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'privatelink.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'privatelink.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'privatelink.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'privatelink.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'privatelink.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'privatelink.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'privatelink.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'privatelink.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'privatelink.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'privatelink.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'privatelink.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'privatelink.cn-shenzhen-finance-1.aliyuncs.com', + ], + ], +]; |