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/zh_cn/ga | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/ga')
| -rw-r--r-- | data/zh_cn/ga/2019-11-20/api-docs.php | 33220 |
1 files changed, 33220 insertions, 0 deletions
diff --git a/data/zh_cn/ga/2019-11-20/api-docs.php b/data/zh_cn/ga/2019-11-20/api-docs.php new file mode 100644 index 0000000..b7d5882 --- /dev/null +++ b/data/zh_cn/ga/2019-11-20/api-docs.php @@ -0,0 +1,33220 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Ga', + 'version' => '2019-11-20', + ], + 'directories' => [ + [ + 'id' => 70618, + 'title' => '区域与地域', + 'type' => 'directory', + 'children' => [ + 'ListAccelerateAreas', + 'ListBusiRegions', + 'DescribeRegions', + 'ListAvailableBusiRegions', + 'ListCommonAreas', + ], + ], + [ + 'id' => 179045, + 'title' => '资源组', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 179046, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'ListTagResources', + 'UntagResources', + ], + ], + [ + 'id' => 179047, + 'title' => '询价', + 'type' => 'directory', + 'children' => [ + 'DescribeCommodity', + 'DescribeCommodityPrice', + ], + ], + [ + 'id' => 70580, + 'title' => '带宽包', + 'type' => 'directory', + 'children' => [ + 'BandwidthPackageAddAccelerator', + 'BandwidthPackageRemoveAccelerator', + 'DescribeBandwidthPackage', + 'ListBandwidthPackages', + 'UpdateBandwidthPackage', + 'ReplaceBandwidthPackage', + 'DeleteBandwidthPackage', + 'CreateBandwidthPackage', + 'ListBandwidthackages', + 'DescribeBandwidthPackageAutoRenewAttribute', + 'UpdateBandwidthPackagaAutoRenewAttribute', + ], + ], + [ + 'id' => 179050, + 'title' => '公网线路类型及传输网络质量类型', + 'type' => 'directory', + 'children' => [ + 'ListIspTypes', + 'UpdateAcceleratorCrossBorderMode', + 'UpdateAcceleratorCrossBorderStatus', + ], + ], + [ + 'id' => 70574, + 'title' => '全球加速实例', + 'type' => 'directory', + 'children' => [ + 'CreateAccelerator', + 'DescribeAccelerator', + 'ListAccelerators', + 'UpdateAccelerator', + 'UpdateAcceleratorConfirm', + 'DeleteAccelerator', + 'AttachDdosToAccelerator', + 'DetachDdosFromAccelerator', + 'CreateSpareIps', + 'ListSpareIps', + 'GetSpareIp', + 'DeleteSpareIps', + 'DescribeAcceleratorAutoRenewAttribute', + 'UpdateAcceleratorAutoRenewAttribute', + ], + ], + [ + 'id' => 70590, + 'title' => '加速区域', + 'type' => 'directory', + 'children' => [ + 'CreateIpSets', + 'DescribeIpSet', + 'ListIpSets', + 'UpdateIpSet', + 'UpdateIpSets', + 'DeleteIpSet', + 'DeleteIpSets', + 'ListAvailableAccelerateAreas', + 'GetIpsetsBandwidthLimit', + ], + ], + [ + 'id' => 70599, + 'title' => '监听', + 'type' => 'directory', + 'children' => [ + 'CreateListener', + 'DescribeListener', + 'ListListeners', + 'UpdateListener', + 'DeleteListener', + 'GetHealthStatus', + 'AssociateAdditionalCertificatesWithListener', + 'DissociateAdditionalCertificatesFromListener', + 'UpdateAdditionalCertificateWithListener', + 'ListListenerCertificates', + 'ListSystemSecurityPolicies', + ], + ], + [ + 'id' => 70608, + 'title' => '终端节点组（智能路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'CreateEndpointGroup', + 'DescribeEndpointGroup', + 'ListEndpointGroups', + 'UpdateEndpointGroup', + 'UpdateEndpointGroupAttribute', + 'DeleteEndpointGroup', + 'DescribeLogStoreOfEndpointGroup', + 'AttachLogStoreToEndpointGroup', + 'DetachLogStoreFromEndpointGroup', + 'CreateEndpointGroups', + 'UpdateEndpointGroups', + 'ConfigEndpointProbe', + 'DeleteEndpointGroups', + ], + ], + [ + 'id' => 179083, + 'title' => '终端节点组（自定义路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'CreateCustomRoutingEndpointGroups', + 'UpdateCustomRoutingEndpointGroupAttribute', + 'DescribeCustomRoutingEndpointGroup', + 'ListCustomRoutingEndpointGroups', + 'DeleteCustomRoutingEndpointGroups', + ], + ], + [ + 'id' => 172050, + 'title' => '终端节点组映射信息（自定义路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'CreateCustomRoutingEndpointGroupDestinations', + 'UpdateCustomRoutingEndpointGroupDestinations', + 'DescribeCustomRoutingEndpointGroupDestinations', + 'ListCustomRoutingEndpointGroupDestinations', + 'DeleteCustomRoutingEndpointGroupDestinations', + ], + ], + [ + 'id' => 171156, + 'title' => '终端节点（自定义路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'CreateCustomRoutingEndpoints', + 'UpdateCustomRoutingEndpoints', + 'DescribeCustomRoutingEndpoint', + 'ListCustomRoutingEndpoints', + 'DeleteCustomRoutingEndpoints', + ], + ], + [ + 'id' => 179084, + 'title' => '终端节点流量通行目标（自定义路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'CreateCustomRoutingEndpointTrafficPolicies', + 'UpdateCustomRoutingEndpointTrafficPolicies', + 'DescribeCustomRoutingEndPointTrafficPolicy', + 'ListCustomRoutingEndpointTrafficPolicies', + 'DeleteCustomRoutingEndpointTrafficPolicies', + ], + ], + [ + 'id' => 179085, + 'title' => '端口映射表（自定义路由类型监听）', + 'type' => 'directory', + 'children' => [ + 'ListCustomRoutingPortMappings', + 'ListCustomRoutingPortMappingsByDestination', + ], + ], + [ + 'id' => 70569, + 'title' => '转发策略', + 'type' => 'directory', + 'children' => [ + 'CreateForwardingRules', + 'UpdateForwardingRules', + 'ListForwardingRules', + 'DeleteForwardingRules', + ], + ], + [ + 'id' => 70556, + 'title' => '访问控制', + 'type' => 'directory', + 'children' => [ + 'CreateAcl', + 'UpdateAclAttribute', + 'AddEntriesToAcl', + 'RemoveEntriesFromAcl', + 'ListAcls', + 'GetAcl', + 'DeleteAcl', + 'AssociateAclsWithListener', + 'DissociateAclsFromListener', + ], + ], + [ + 'id' => 171147, + 'title' => '源站探测', + 'type' => 'directory', + 'children' => [ + 'CreateApplicationMonitor', + 'UpdateApplicationMonitor', + 'DisableApplicationMonitor', + 'EnableApplicationMonitor', + 'DeleteApplicationMonitor', + 'ListApplicationMonitor', + 'DescribeApplicationMonitor', + 'DetectApplicationMonitor', + 'ListApplicationMonitorDetectResult', + ], + ], + [ + 'id' => 179068, + 'title' => '域名管理', + 'type' => 'directory', + 'children' => [ + 'CreateDomain', + 'UpdateDomainState', + 'UpdateDomain', + 'ListDomains', + 'GetInvalidDomainCount', + 'DeleteDomainAcceleratorRelation', + ], + ], + [ + 'id' => 171162, + 'title' => '基础型全球加速实例', + 'type' => 'directory', + 'children' => [ + 'CreateBasicAccelerator', + 'UpdateBasicAccelerator', + 'GetBasicAccelerator', + 'ListBasicAccelerators', + 'DeleteBasicAccelerator', + ], + ], + [ + 'id' => 179069, + 'title' => '加速地域（基础型全球加速实例）', + 'type' => 'directory', + 'children' => [ + 'CreateBasicIpSet', + 'UpdateBasicIpSet', + 'GetBasicIpSet', + 'DeleteBasicIpSet', + ], + ], + [ + 'id' => 179070, + 'title' => '加速IP（基础型全球加速实例）', + 'type' => 'directory', + 'children' => [ + 'CreateBasicAccelerateIp', + 'GetBasicAccelerateIp', + 'GetBasicAccelerateIpIdleCount', + 'ListBasicAccelerateIps', + 'DeleteBasicAccelerateIp', + ], + ], + [ + 'id' => 171172, + 'title' => '终端节点组（基础型全球加速实例）', + 'type' => 'directory', + 'children' => [ + 'CreateBasicEndpointGroup', + 'UpdateBasicEndpointGroup', + 'GetBasicEndpointGroup', + 'DeleteBasicEndpointGroup', + ], + ], + [ + 'id' => 179071, + 'title' => '终端节点（基础型全球加速实例）', + 'type' => 'directory', + 'children' => [ + 'CreateBasicEndpoint', + 'CreateBasicEndpoints', + 'UpdateBasicEndpoint', + 'GetBasicEndpoint', + 'ListBasicEndpoints', + 'DeleteBasicEndpoint', + ], + ], + [ + 'id' => 179086, + 'title' => '加速IP与终端节点的绑定关系（基础型全球加速实例）', + 'type' => 'directory', + 'children' => [ + 'CreateBasicAccelerateIpEndpointRelations', + 'CreateBasicAccelerateIpEndpointRelation', + 'GetBasicAccelerateIpEndpointRelation', + 'ListBasicAccelerateIpEndpointRelations', + 'DeleteBasicAccelerateIpEndpointRelation', + ], + ], + [ + 'id' => 181801, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'UpdateServiceManagedControl', + 'QueryCrossBorderApprovalStatus', + 'DescribeAcceleratorServiceStatus', + 'OpenAcceleratorService', + 'ListEndpointGroupIpAddressCidrBlocks', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'UpdateLogStoreConfig', + 'GetGlobalAcceleratorResources', + 'DisassociateResources', + 'AssociateResources', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ListAccelerateAreas' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'Areas' => [ + 'description' => '区域信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '区域名称。', + 'type' => 'string', + 'example' => '华北', + ], + 'AreaId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-huabei', + ], + 'RegionList' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '青岛', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"Areas\\": [\\n {\\n \\"LocalName\\": \\"华北\\",\\n \\"AreaId\\": \\"cn-huabei\\",\\n \\"RegionList\\": [\\n {\\n \\"LocalName\\": \\"青岛\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAccelerateAreasResponse>\\n<Areas>\\n <AreaId>North-America</AreaId>\\n <LocalName>北美</LocalName>\\n <RegionList>\\n <RegionId>us-west-1</RegionId>\\n <LocalName>美国（硅谷）</LocalName>\\n </RegionList>\\n <RegionList>\\n <RegionId>us-east-1</RegionId>\\n <LocalName>美国（弗吉尼亚）</LocalName>\\n </RegionList>\\n</Areas>\\n<Areas>\\n <AreaId>China</AreaId>\\n <LocalName>中国</LocalName>\\n <RegionList>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>杭州</LocalName>\\n </RegionList>\\n <RegionList>\\n <RegionId>cn-beijing</RegionId>\\n <LocalName>北京</LocalName>\\n </RegionList>\\n</Areas>\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</ListAccelerateAreasResponse>","errorExample":""}]', + 'title' => '查询可用的加速区域和地域', + 'summary' => '调用ListAccelerateAreas查询可用的加速区域和地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListBusiRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8887', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + 'Regions' => [ + 'description' => '全球加速服务支持的地域信息。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速服务支持的地域信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '杭州', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"杭州\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>1A2262A0-B50A-4C27-8543-E91D9447F967</RequestId>\\n<Regions>\\n <RegionId>cn-qingdao</RegionId>\\n <LocalName>青岛</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>us-west-1</RegionId>\\n <LocalName>美国（硅谷）</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-beijing</RegionId>\\n <LocalName>北京</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>杭州</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-shanghai</RegionId>\\n <LocalName>上海</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-chengdu</RegionId>\\n <LocalName>成都</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-shenzhen</RegionId>\\n <LocalName>深圳</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>cn-hongkong</RegionId>\\n <LocalName>中国香港</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-northeast-1</RegionId>\\n <LocalName>日本</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-south-1</RegionId>\\n <LocalName>印度</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-southeast-1</RegionId>\\n <LocalName>新加坡</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-southeast-2</RegionId>\\n <LocalName>悉尼</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-southeast-3</RegionId>\\n <LocalName>马来西亚</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-southeast-5</RegionId>\\n <LocalName>印度尼西亚</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>us-east-1</RegionId>\\n <LocalName>美国（弗吉尼亚）</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>eu-central-1</RegionId>\\n <LocalName>德国</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>eu-west-1</RegionId>\\n <LocalName>英国</LocalName>\\n</Regions>\\n<Regions>\\n <RegionId>ap-northeast-2-pop</RegionId>\\n <LocalName>韩国</LocalName>\\n</Regions>","errorExample":""}]', + 'title' => '查询加速业务支持的地域', + 'summary' => '调用ListBusiRegions查询全球加速服务支持的地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F', + ], + 'Regions' => [ + 'description' => '可用地域的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '可用地域的集合。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '杭州', + ], + 'RegionId' => [ + 'description' => '全球加速实例所属的地域ID。仅返回**cn-hangzhou**。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"杭州\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用的实例部署的地域', + 'summary' => '调用DescribeRegions查询可用的全球加速实例部署地域。', + ], + 'ListAvailableBusiRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8884', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID。取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'Regions' => [ + 'description' => '地域信息。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '青岛', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Pop' => [ + 'description' => '是否为阿里云POP点。取值：'."\n" + ."\n" + .'- **true**：是阿里云POP点。'."\n" + ."\n" + .'- **false**：不是阿里云POP点。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ChinaMainland' => [ + 'description' => '是否为中国内地地域。取值：'."\n" + ."\n" + .'- **true**：是中国内地地域。'."\n" + ."\n" + .'- **false**：非中国内地地域。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"青岛\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Pop\\": false,\\n \\"ChinaMainland\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAvailableBusiRegionsResponse>\\n <RequestId>8BE7678A-EEFC-5A7C-9028-B5D6C5A33CA9</RequestId>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-qingdao</RegionId>\\n <LocalName>青岛</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-beijing</RegionId>\\n <LocalName>北京</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-shanghai</RegionId>\\n <LocalName>上海</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-chengdu</RegionId>\\n <LocalName>成都</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-shenzhen</RegionId>\\n <LocalName>深圳</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>杭州</LocalName>\\n </Regions>\\n <Regions>\\n <Pop>false</Pop>\\n <RegionId>cn-guangzhou</RegionId>\\n <LocalName>广州</LocalName>\\n </Regions>\\n</ListAvailableBusiRegionsResponse>","errorExample":""}]', + 'title' => '列出可用的业务区域', + 'summary' => '调用ListAvailableBusiRegions接口查询指定全球加速实例可用的加速地域。', + ], + 'ListCommonAreas' => [ + 'summary' => '调用ListCommonAreas接口查询可用的加速区域和地域。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '接入全球加速服务的IP地址协议，取值：'."\n" + .'- **IPv4**（默认值）：IPv4地址协议，即查询支持IPv4的地域。'."\n" + .'- **IPv6**：IPv6地址协议，即查询支持IPv6的地域。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'IsIpSet', + 'in' => 'query', + 'schema' => [ + 'description' => '是否为全球加速支持的加速地域。'."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsEpg', + 'in' => 'query', + 'schema' => [ + 'description' => '是否为全球加速支持的终端节点组地域。'."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'Areas' => [ + 'description' => '区域信息。', + 'type' => 'array', + 'items' => [ + 'description' => '区域信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '区域名称。', + 'type' => 'string', + 'example' => '华北', + ], + 'AreaId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-huabei', + ], + 'RegionList' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '地域列表信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '青岛', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"Areas\\": [\\n {\\n \\"LocalName\\": \\"华北\\",\\n \\"AreaId\\": \\"cn-huabei\\",\\n \\"RegionList\\": [\\n {\\n \\"LocalName\\": \\"青岛\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCommonAreasResponse>\\n <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>\\n <Areas>\\n <LocalName>华北</LocalName>\\n <AreaId>cn-huabei</AreaId>\\n <RegionList>\\n <LocalName>青岛</LocalName>\\n <RegionId>cn-qingdao</RegionId>\\n </RegionList>\\n </Areas>\\n</ListCommonAreasResponse>","errorExample":""}]', + 'title' => '查询加速业务支持的地域', + 'description' => '本接口主要用于查询全球加速向导页面的智能推荐及免费体验活动可用的加速区域和地域。您可以根据指定条件进行过滤筛选。', + ], + 'ChangeResourceGroup' => [ + 'summary' => '调用ChangeResourceGroup接口修改全球加速资源所属的资源组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152996', + 'abilityTreeNodes' => [ + 'FEATUREgaTV52LF', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。**ClientToken**只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改资源组的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要替换的新的资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekzrnd67gq****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改资源组的全球加速资源类型。取值：'."\n" + .'- **accelerator**：标准型全球加速实例。'."\n" + .'- **basicaccelerator**：基础型全球加速实例。'."\n" + .'- **bandwidthpackage**：带宽包。'."\n" + .'- **acl**：访问控制策略组。', + 'type' => 'string', + 'required' => true, + 'example' => 'accelerator', + 'minLength' => 0, + 'enum' => [ + 'accelerator', + 'basicaccelerator', + 'bandwidthpackage', + 'acl', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceGroupResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</ChangeResourceGroupResponse>","errorExample":""}]', + 'title' => '修改全球加速资源所属的资源组', + 'description' => '**ChangeResourceGroup**接口不支持在同一个全球加速实例内并发修改全球加速资源所属的资源组。', + ], + 'TagResources' => [ + 'summary' => '调用TagResources接口为全球加速资源添加标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152997', + 'abilityTreeNodes' => [ + 'FEATUREgaZTNSJU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '待添加标签的全球加速资源类型。取值：'."\n" + .'- **accelerator**：标准型全球加速实例。'."\n" + .'- **basicaccelerator**：基础型全球加速实例。'."\n" + .'- **bandwidthpackage**：带宽包。'."\n" + .'- **acl**：访问控制策略组。'."\n" + .'- **endpointgroup**：终端节点组。', + 'type' => 'string', + 'required' => true, + 'example' => 'accelerator', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '待添加标签的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'至少输入1个全球加速资源ID，最多支持输入50个全球加速资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '待添加标签的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'至少输入1个全球加速资源ID，最多支持输入50个全球加速资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '全球加速资源的标签列表。'."\n" + ."\n" + .'最多输入20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速资源的标签列表。'."\n" + ."\n" + .'最多输入20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '全球加速资源的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'KeyTest', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '全球加速资源的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'valueTest', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '为全球加速资源添加标签', + 'description' => '单个全球加速资源最多可绑定20条标签。绑定标签前，阿里云会校验资源已有标签数量，超过限制值会返回报错信息。', + ], + 'ListTagResources' => [ + 'summary' => '调用ListTagResources接口查询全球加速资源已经绑定的标签列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152999', + 'abilityTreeNodes' => [ + 'FEATUREgaZTNSJU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '待查询标签信息的全球加速资源类型。取值：'."\n" + .'- **accelerator**：标准型全球加速实例。'."\n" + .'- **basicaccelerator**：基础型全球加速实例。'."\n" + .'- **bandwidthpackage**：带宽包。'."\n" + .'- **acl**：访问控制策略组。'."\n" + .'- **endpointgroup**：终端节点组。', + 'type' => 'string', + 'required' => true, + 'example' => 'accelerator', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '待查询标签信息的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'最多支持输入50个全球加速资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '待查询标签信息的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'最多支持输入50个全球加速资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '全球加速资源的标签列表。'."\n" + ."\n" + .'最多输入20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速资源的标签列表。'."\n" + ."\n" + .'最多输入20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '全球加速资源的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'KeyTest', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '全球加速资源的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'valueTest', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => '绑定标签的全球加速资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定标签的全球加速资源信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '全球加速资源类型。'."\n" + .'- **accelerator**：标准型全球加速实例。'."\n" + .'- **basicaccelerator**：基础型全球加速实例。'."\n" + .'- **bandwidthpackage**：带宽包。'."\n" + .'- **acl**：访问控制策略组。'."\n" + .'- **endpointgroup**：终端节点组。', + 'type' => 'string', + 'example' => 'accelerator', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'KeyTest', + ], + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => '全球加速资源ID。', + 'type' => 'string', + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + 'TagKey' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'valueTest', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"accelerator\\",\\n \\"TagValue\\": \\"KeyTest\\",\\n \\"ResourceId\\": \\"ga-bp149u6o36qt1as9b****\\",\\n \\"TagKey\\": \\"valueTest\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <TagResources>\\n <ResourceType>accelerator</ResourceType>\\n <TagValue>KeyTest</TagValue>\\n <ResourceId>ga-bp149u6o36qt1as9b****</ResourceId>\\n <TagKey>valueTest</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => '查询全球加速资源已经绑定的标签列表', + 'description' => '- 请求中至少指定参数**ResourceId**或**Tag**（**Key**与**Value**），以确定检索对象。'."\n" + .'- **Tag**是资源的标签，由一个键值对组成。仅指定**Key**时，则返回该标签键关联的所有标签值。仅指定**Value**会报错。'."\n" + .'- 如果您同时指定**Tag**和**ResourceId**筛选标签，则**ResourceId**必须满足所有输入的标签键值对。'."\n" + .'- 如果您同时指定多个标签键值对，返回结果为同时包含被指定的多个键值对的资源。', + ], + 'UntagResources' => [ + 'summary' => '调用UntagResources接口为全球加速相关资源删除标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152998', + 'abilityTreeNodes' => [ + 'FEATUREgaZTNSJU', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '待删除标签的全球加速资源类型。取值：'."\n" + .'- **accelerator**：标准型全球加速实例。'."\n" + .'- **basicaccelerator**：基础型全球加速实例。'."\n" + .'- **bandwidthpackage**：带宽包。'."\n" + .'- **acl**：访问控制策略组。'."\n" + .'- **endpointgroup**：终端节点组。', + 'type' => 'string', + 'required' => true, + 'example' => 'accelerator', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', + 'description' => '是否将指定全球加速资源下所有标签全部删除。 取值： '."\n" + ."\n" + .'- **true**：是。'."\n" + .' '."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID，最多50个子项', + 'description' => '待删除标签的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'最多支持输入50个全球加速资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除标签的全球加速资源ID。'."\n" + .'- 当**ResourceType**取值为**accelerator**时，取值为标准型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**basicaccelerator**时，取值为基础型全球加速实例ID。'."\n" + .'- 当**ResourceType**取值为**bandwidthpackage**时，取值为带宽包ID。'."\n" + .'- 当**ResourceType**取值为**acl**时，取值为访问控制策略组ID。'."\n" + .'- 当**ResourceType**取值为**endpointgroup**时，取值为终端节点组ID。'."\n" + ."\n" + .'最多支持输入50个全球加速资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签键，最多20个子项', + 'description' => '指定待删除标签的标签键。'."\n" + ."\n" + .'系统会删除全球加速资源上所有该标签键的标签。'."\n" + ."\n" + .'最多支持输入20个标签键。'."\n" + ."\n" + .'> **All**取值为**true**时，本参数不生效。', + 'type' => 'array', + 'items' => [ + 'description' => '指定待删除标签的标签键。'."\n" + ."\n" + .'系统会删除全球加速资源上所有该标签键的标签。'."\n" + ."\n" + .'最多支持输入20个标签键。'."\n" + .'> **All**取值为**true**时，本参数不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'valueTest', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '为全球加速相关资源删除标签', + ], + 'DescribeCommodity' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155893', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品Code。'."\n" + ."\n" + .'中国站示例值：'."\n" + ."\n" + .'- **ga\\_gapluspre\\_public\\_cn**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_plusbwppre\\_public_cn**：基础带宽包。'."\n" + ."\n" + .'国际站示例值：'."\n" + ."\n" + .'- **ga\\_pluspre\\_public_intl**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_bwppreintl\\_public_intl**：基础带宽包。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ga_gapluspre_public_cn', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型。取值：'."\n" + .'- **BUY**：新购。'."\n" + .'- **RENEW**：续费。'."\n" + .'- **UPGRADE**：升级。', + 'type' => 'string', + 'required' => true, + 'example' => 'BUY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品Code。'."\n" + ."\n" + .'中国站返回示例值：'."\n" + ."\n" + .'- **ga\\_gapluspre\\_public\\_cn**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_plusbwppre\\_public_cn**：基础带宽包。'."\n" + ."\n" + .'国际站返回示例值：'."\n" + ."\n" + .'- **ga\\_pluspre\\_public_intl**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_bwppreintl\\_public_intl**：基础带宽包。', + 'type' => 'string', + 'example' => 'ga_gapluspre_public_cn', + ], + 'CommodityName' => [ + 'description' => '商品名称。', + 'type' => 'string', + 'example' => '全球加速_实例规格（包年包月）', + ], + 'Components' => [ + 'description' => '商品模块信息。'."\n" + ."\n" + .'不同商品返回内容不同。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块信息。'."\n" + ."\n" + .'不同商品返回内容不同。', + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => [ + 'description' => '商品模块Code。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '购买时长', + ], + 'ComponentName' => [ + 'description' => '商品模块名称。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '购买时长', + ], + 'Properties' => [ + 'description' => '商品模块属性。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块属性。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '商品模块属性Code。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => 'ord_time', + ], + 'Name' => [ + 'description' => '商品模块属性名称。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '购买时长', + ], + 'PropertyValueList' => [ + 'description' => '商品模块属性值列表。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块属性值列表。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '商品模块属性内容。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '1个月', + ], + 'Value' => [ + 'description' => '商品模块属性值。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '1:Month', + ], + 'Tips' => [ + 'description' => '商品模块属性提示信息。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'string', + 'example' => '1个月', + ], + 'OrderIndex' => [ + 'description' => '商品模块属性显示顺序。'."\n" + ."\n" + .'不同商品模块返回内容不同。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CommodityCode\\": \\"ga_gapluspre_public_cn\\",\\n \\"CommodityName\\": \\"全球加速_实例规格（包年包月）\\",\\n \\"Components\\": [\\n {\\n \\"ComponentCode\\": \\"购买时长\\",\\n \\"ComponentName\\": \\"购买时长\\",\\n \\"Properties\\": [\\n {\\n \\"Code\\": \\"ord_time\\",\\n \\"Name\\": \\"购买时长\\",\\n \\"PropertyValueList\\": [\\n {\\n \\"Text\\": \\"1个月\\",\\n \\"Value\\": \\"1:Month\\",\\n \\"Tips\\": \\"1个月\\",\\n \\"OrderIndex\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCommodityResponse>\\n <CommodityCode>ga_gapluspre_public_cn</CommodityCode>\\n <CommodityName>全球加速_实例规格（包年包月）</CommodityName>\\n <Components>\\n <ComponentCode>购买时长</ComponentCode>\\n <ComponentName>购买时长</ComponentName>\\n <Properties>\\n <Code>ord_time</Code>\\n <Name>购买时长</Name>\\n <PropertyValueList>\\n <Text>1个月</Text>\\n <Value>1:Month</Value>\\n <Tips>1个月</Tips>\\n <OrderIndex>1</OrderIndex>\\n </PropertyValueList>\\n </Properties>\\n </Components>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DescribeCommodityResponse>","errorExample":""}]', + 'title' => '查询全球加速商品信息', + 'summary' => '调用DescribeCommodity接口查询全球加速商品信息。', + ], + 'DescribeCommodityPrice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Orders', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '商品订单。', + 'type' => 'array', + 'items' => [ + 'description' => '商品订单。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品Code。'."\n" + ."\n" + .'中国站示例值：'."\n" + ."\n" + .'- **ga\\_gapluspre\\_public\\_cn**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_plusbwppre\\_public_cn**：基础带宽包。'."\n" + ."\n" + .'国际站示例值：'."\n" + ."\n" + .'- **ga\\_pluspre\\_public_intl**：全球加速实例。'."\n" + ."\n" + .'- **ga\\_bwppreintl\\_public_intl**：基础带宽包。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ga_gapluspre_public_cn', + ], + 'OrderType' => [ + 'description' => '订单类型。取值：'."\n" + .'- **BUY**：新购。'."\n" + .'- **RENEW**：续费。'."\n" + .'- **UPGRADE**：升级。', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + ], + 'ChargeType' => [ + 'description' => '计费方式。'."\n" + .'取值**PREPAY**，表示预付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + ], + 'PricingCycle' => [ + 'description' => '计费周期。取值：'."\n" + .'- **Month**：按月计费。'."\n" + .'- **Year**：按年计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'Duration' => [ + 'description' => '购买时长。'."\n" + .'- 当**PricingCycle**取值**Month**时，Duration取值范围为**1**~**9**。'."\n" + .'- 当**PricingCycle**取值**Year**时，Duration取值范围为**1**~**3**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Quantity' => [ + 'description' => '购买数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Components' => [ + 'description' => '商品模块信息。'."\n" + ."\n" + .'不同商品模块，信息不同。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '商品模块信息。'."\n" + ."\n" + .'不同商品模块，信息不同。', + 'type' => 'object', + 'properties' => [ + 'ComponentCode' => [ + 'description' => '商品模块Code。'."\n" + ."\n" + .'不同商品模块，信息不同。'."\n" + .'例如：**instance**（全球加速实例）、**购买时长**（商品购买时长）。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Properties' => [ + 'description' => '商品模块属性。'."\n" + ."\n" + .'不同商品模块，信息不同。', + 'type' => 'array', + 'items' => [ + 'description' => '商品模块属性。'."\n" + ."\n" + .'不同商品模块，信息不同。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '商品模块属性Code。'."\n" + ."\n" + .'不同商品模块，信息不同。'."\n" + .'例如：**instance**（全球加速实例）、**ord_time**（商品购买时长）。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'Value' => [ + 'description' => '商品模块属性值。'."\n" + ."\n" + .'不同商品模块，信息不同。'."\n" + .'例如：**instance_fee**（全球加速实例费）、**1:Month**（购买时长为1个月）。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance_fee', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'PromotionOptionNo', + 'in' => 'query', + 'schema' => [ + 'title' => '优惠券号码', + 'description' => '优惠券号码。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '50003298014****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'Currency' => [ + 'description' => '货币单位。'."\n" + ."\n" + .'- 中国站：**CNY**。'."\n" + ."\n" + .'- 国际站：**USD**。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2099', + ], + 'DiscountPrice' => [ + 'description' => '折扣金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '419.8', + ], + 'TradePrice' => [ + 'description' => '最终价，为原价减去折扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1679.2', + ], + 'OrderDetails' => [ + 'description' => '计价模块价格详情。', + 'type' => 'array', + 'items' => [ + 'description' => '计价模块价格详情。', + 'type' => 'object', + 'properties' => [ + 'CommodityCode' => [ + 'description' => '商品Code。', + 'type' => 'string', + 'example' => 'ga_gapluspre_public_cn', + ], + 'CommodityName' => [ + 'description' => '商品名称。', + 'type' => 'string', + 'example' => '全球加速_实例规格（包年包月）', + ], + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2099', + ], + 'DiscountPrice' => [ + 'description' => '折扣金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '419.8', + ], + 'TradePrice' => [ + 'description' => '最终价，为原价减去折扣。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1679.2', + ], + 'Quantity' => [ + 'description' => '购买数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ModuleDetails' => [ + 'description' => '模块价格信息。', + 'type' => 'array', + 'items' => [ + 'description' => '模块价格信息。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '计价模块Code。', + 'type' => 'string', + 'example' => 'spec', + ], + 'ModuleName' => [ + 'description' => '计价模块名称。', + 'type' => 'string', + 'example' => '规格', + ], + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '200000.0', + ], + 'DiscountPrice' => [ + 'description' => '折扣金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '40000.0', + ], + 'TradePrice' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '160000.0', + ], + ], + ], + ], + 'RuleIds' => [ + 'description' => '优惠规则ID。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102104100786****', + ], + ], + 'PromDetails' => [ + 'description' => '优惠细则。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠细则。'."\n" + .'> 中国站不涉及该参数。', + 'type' => 'object', + 'properties' => [ + 'PromotionId' => [ + 'description' => '优惠项ID。'."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => '50003298014****', + ], + 'PromotionName' => [ + 'description' => '优惠项名称。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => 'coupon', + ], + 'FinalPromFee' => [ + 'description' => '优惠价格。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.01', + ], + 'PromType' => [ + 'description' => '优惠子类型。'."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => 'deduct', + ], + 'OptionCode' => [ + 'description' => '优惠选项Code。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => 'youhui_quan', + ], + ], + ], + ], + ], + ], + ], + 'RuleDetails' => [ + 'description' => '优惠规则详情。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠规则详情。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '优惠规则ID。', + 'type' => 'string', + 'example' => '102104100786****', + ], + 'RuleName' => [ + 'description' => '优惠规则名称。', + 'type' => 'string', + 'example' => 'GA新客户小型II规格月付-8折优惠', + ], + ], + ], + ], + 'Promotions' => [ + 'description' => '优惠券列表。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠券列表。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'object', + 'properties' => [ + 'PromotionOptionNo' => [ + 'title' => '优惠号', + 'description' => '优惠券号码。'."\n" + ."\n" + .'>- `youhuiquan_promotion_option_id_for_blank`代表不适用优惠券。'."\n" + .'>- 中国站不涉及该参数。', + 'type' => 'string', + 'example' => '50003298014****', + ], + 'PromotionName' => [ + 'title' => '优惠名称', + 'description' => '优惠券名称。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'CanPromFee' => [ + 'title' => '可优惠价格', + 'description' => '可优惠金额。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'Selected' => [ + 'title' => '是否外部选中', + 'description' => '是否被选中。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OptionCode' => [ + 'title' => '优惠选项code', + 'description' => '优惠券商品Code。'."\n" + ."\n" + .'> 中国站不涉及该参数。', + 'type' => 'string', + 'example' => 'youhui_quan', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter.Spec', + 'errorMessage' => 'The specified Spec is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Currency\\": \\"CNY\\",\\n \\"OriginalPrice\\": 2099,\\n \\"DiscountPrice\\": 419.8,\\n \\"TradePrice\\": 1679.2,\\n \\"OrderDetails\\": [\\n {\\n \\"CommodityCode\\": \\"ga_gapluspre_public_cn\\",\\n \\"CommodityName\\": \\"全球加速_实例规格（包年包月）\\",\\n \\"OriginalPrice\\": 2099,\\n \\"DiscountPrice\\": 419.8,\\n \\"TradePrice\\": 1679.2,\\n \\"Quantity\\": 1,\\n \\"ModuleDetails\\": [\\n {\\n \\"ModuleCode\\": \\"spec\\",\\n \\"ModuleName\\": \\"规格\\",\\n \\"OriginalPrice\\": 200000,\\n \\"DiscountPrice\\": 40000,\\n \\"TradePrice\\": 160000\\n }\\n ],\\n \\"RuleIds\\": [\\n 0\\n ],\\n \\"PromDetails\\": [\\n {\\n \\"PromotionId\\": \\"50003298014****\\",\\n \\"PromotionName\\": \\"coupon\\",\\n \\"FinalPromFee\\": 0.01,\\n \\"PromType\\": \\"deduct\\",\\n \\"OptionCode\\": \\"youhui_quan\\"\\n }\\n ]\\n }\\n ],\\n \\"RuleDetails\\": [\\n {\\n \\"RuleId\\": \\"102104100786****\\",\\n \\"RuleName\\": \\"GA新客户小型II规格月付-8折优惠\\"\\n }\\n ],\\n \\"Promotions\\": [\\n {\\n \\"PromotionOptionNo\\": \\"50003298014****\\",\\n \\"PromotionName\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"CanPromFee\\": 0,\\n \\"Selected\\": false,\\n \\"OptionCode\\": \\"youhui_quan\\"\\n }\\n ],\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCommodityPriceResponse>\\n <Currency>CNY</Currency>\\n <OriginalPrice>2099</OriginalPrice>\\n <DiscountPrice>419.8</DiscountPrice>\\n <TradePrice>1679.2</TradePrice>\\n <OrderDetails>\\n <CommodityCode>ga_gapluspre_public_cn</CommodityCode>\\n <CommodityName>全球加速_实例规格（包年包月）</CommodityName>\\n <OriginalPrice>2099</OriginalPrice>\\n <DiscountPrice>419.8</DiscountPrice>\\n <TradePrice>1679.2</TradePrice>\\n <Quantity>1</Quantity>\\n <ModuleDetails>\\n <ModuleCode>spec</ModuleCode>\\n <ModuleName>规格</ModuleName>\\n <OriginalPrice>200000</OriginalPrice>\\n <DiscountPrice>40000</DiscountPrice>\\n <TradePrice>160000</TradePrice>\\n </ModuleDetails>\\n <PromDetails>\\n <PromotionId>50003298014****</PromotionId>\\n <PromotionName>coupon</PromotionName>\\n <FinalPromFee>0.01</FinalPromFee>\\n <PromType>deduct</PromType>\\n <OptionCode>youhui_quan</OptionCode>\\n </PromDetails>\\n </OrderDetails>\\n <RuleDetails>\\n <RuleId>102104100786****</RuleId>\\n <RuleName>GA新客户小型II规格月付-8折优惠</RuleName>\\n </RuleDetails>\\n <Promotions>\\n <PromotionOptionNo>50003298014****</PromotionOptionNo>\\n <PromotionName>youhuiquan_promotion_option_id_for_blank</PromotionName>\\n <CanPromFee>0</CanPromFee>\\n <Selected>false</Selected>\\n <OptionCode>youhui_quan</OptionCode>\\n </Promotions>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DescribeCommodityPriceResponse>","errorExample":""}]', + 'title' => '查询全球加速商品的价格信息', + 'summary' => '调用DescribeCommodityPrice接口查询全球加速商品的价格信息。', + 'description' => '您可以通过调用[DescribeCommodity](~~2253233~~)查询商品模块信息。', + ], + 'BandwidthPackageAddAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7839', + 'abilityTreeNodes' => [ + 'FEATUREgaAKFA2Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '与全球加速实例绑定的带宽包的ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '与带宽包绑定的全球加速实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B7770CB9-9745-4FE5-9EDA-D14B01A12A50', + ], + 'Accelerators' => [ + 'description' => '与带宽包绑定的全球加速实例的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '与带宽包绑定的全球加速实例的ID。', + 'type' => 'string', + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + 'BandwidthPackageId' => [ + 'description' => '与全球加速实例绑定的带宽包的ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B7770CB9-9745-4FE5-9EDA-D14B01A12A50\\",\\n \\"Accelerators\\": [\\n \\"ga-bp1qe94o52ot4pkfn****\\"\\n ],\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\"\\n}","errorExample":""},{"type":"xml","example":"<BandwidthPackageAddAcceleratorResponse>\\n <RequestId>B7770CB9-9745-4FE5-9EDA-D14B01A12A50</RequestId>\\n <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n</BandwidthPackageAddAcceleratorResponse>","errorExample":""}]', + 'title' => '将带宽包与全球加速实例绑定', + 'summary' => '调用BandwidthPackageAddAccelerator接口将带宽包与全球加速实例绑定。', + 'description' => '- **BandwidthPackageAddAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但带宽包与全球加速实例并未绑定完成，系统后台的绑定任务仍在进行。您可以调用[DescribeBandwidthPackage](~~153241~~)查询带宽包的状态：'."\n" + .' - 当带宽包处于**binding**状态时，表示带宽包与全球加速实例正在绑定中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当带宽包处于**active**状态时，表示带宽包与全球加速实例绑定完成。'."\n" + .'- **BandwidthPackageAddAccelerator**接口不支持为同一个全球加速实例并发绑定带宽包。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BandwidthPackageRemoveAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7840', + 'abilityTreeNodes' => [ + 'FEATUREgaU0NK4N', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '与全球加速实例解绑的带宽包的ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '与带宽包解绑的全球加速实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B7770CB9-9745-4FE5-9EDA-D14B01A12A50', + ], + 'Accelerators' => [ + 'description' => '与带宽包解绑的全球加速实例的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '与带宽包解绑的全球加速实例的ID。', + 'type' => 'string', + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + 'BandwidthPackageId' => [ + 'description' => '与全球加速实例解绑的带宽包的ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'BandwidthPackageCannotUnbind.EndpointGroup', + 'errorMessage' => 'Cross-border bandwidth package cannot be unbound, because endpointGroup contains unsupported regions after unbinding.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B7770CB9-9745-4FE5-9EDA-D14B01A12A50\\",\\n \\"Accelerators\\": [\\n \\"ga-bp1qe94o52ot4pkfn****\\"\\n ],\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\"\\n}","errorExample":""},{"type":"xml","example":"<BandwidthPackageRemoveAcceleratorResponse>\\n <RequestId>B7770CB9-9745-4FE5-9EDA-D14B01A12A50</RequestId>\\n <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n</BandwidthPackageRemoveAcceleratorResponse>","errorExample":""}]', + 'title' => '将带宽包与全球加速实例解绑', + 'summary' => '调用BandwidthPackageRemoveAccelerator接口将带宽包与全球加速实例解绑。', + 'description' => '- 调用**BandwidthPackageRemoveAccelerator**接口前，请确保该全球加速实例下已不存在加速地域和终端节点组。'."\n" + .' - 删除加速地域，请参见[DeleteIpSet](~~2253276~~)或[DeleteIpSets](~~2253278~~)。'."\n" + .' - 删除终端节点组，请参见[DeleteEndpointGroup](~~2253305~~)、[DeleteEndpointGroups](~~2253311~~)或[DeleteCustomRoutingEndpointGroups](~~2303183~~)。'."\n" + .'- **BandwidthPackageRemoveAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但带宽包与全球加速实例并未解绑完成，系统后台的解绑任务仍在进行。您可以调用[DescribeBandwidthPackage](~~153241~~)查询带宽包的状态：'."\n" + .' - 当带宽包处于**unbinding**状态时，表示带宽包与全球加速实例正在解绑中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当带宽包处于**active**状态时，表示带宽包与全球加速实例解绑完成。'."\n" + .'- **BandwidthPackageRemoveAccelerator**接口不支持为同一个全球加速实例并发解绑带宽包。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBandwidthPackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的带宽包的ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'CbnGeographicRegionIdB' => [ + 'description' => '跨地域加速包的互通区域B。仅返回为**Global**（全球）。'."\n" + ."\n" + .'仅国际站支持返回该参数。', + 'type' => 'string', + 'example' => 'Global', + ], + 'CbnGeographicRegionIdA' => [ + 'description' => '跨地域加速包的互通区域A。仅返回为**China-mainland**（中国内地）。'."\n" + ."\n" + .'仅国际站支持返回该参数。', + 'type' => 'string', + 'example' => 'China-mainland', + ], + 'Description' => [ + 'description' => '带宽包的描述。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B6DBBB0-2D01-4C6A-A384-4129266E6B78', + ], + 'CreateTime' => [ + 'description' => '带宽包创建时间的时间戳。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'Name' => [ + 'description' => '带宽包的名称。', + 'type' => 'string', + 'example' => 'testName', + ], + 'BandwidthType' => [ + 'description' => '带宽类型。'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。'."\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'Type' => [ + 'description' => '带宽包的类型。'."\n" + ."\n" + .'- **Basic**：基础带宽包。'."\n" + ."\n" + .'- **CrossDomain**：跨地域加速包。'."\n" + ."\n" + .'中国站仅支持返回**Basic**。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'Accelerators' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + 'State' => [ + 'description' => '带宽包的状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **binded**：已绑定。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。'."\n" + ."\n" + .'- **locked**：已锁定。'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'ChargeType' => [ + 'description' => '付费类型。'."\n" + .'- **PREPAY**（默认值）：预付费，即包年包月。'."\n" + .'- **POSTPAY**：后付费，即按量付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'Bandwidth' => [ + 'description' => '带宽包的带宽值，单位为Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ExpiredTime' => [ + 'description' => '带宽包过期时间的时间戳。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'BandwidthPackageId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + 'RegionId' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'BillingType' => [ + 'description' => '后付费计费方式，取值：'."\n" + .'- **PayByTraffic**：流量计费。'."\n" + .'- **PayBY95**：95计费。'."\n", + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Ratio' => [ + 'description' => '95计费保底比例。取值范围：**30**~**100**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfnvueepcihjiq', + ], + 'Tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CbnGeographicRegionIdB\\": \\"Global\\",\\n \\"CbnGeographicRegionIdA\\": \\"China-mainland\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"RequestId\\": \\"4B6DBBB0-2D01-4C6A-A384-4129266E6B78\\",\\n \\"CreateTime\\": \\"1578966918000\\",\\n \\"Name\\": \\"testName\\",\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"Type\\": \\"Basic\\",\\n \\"Accelerators\\": [\\n \\"ga-bp1qe94o52ot4pkfn****\\"\\n ],\\n \\"State\\": \\"active\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"Bandwidth\\": 2,\\n \\"ExpiredTime\\": \\"1578966918000\\",\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"BillingType\\": \\"PayByTraffic\\",\\n \\"Ratio\\": 30,\\n \\"ResourceGroupId\\": \\"rg-acfnvueepcihjiq\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeBandwidthPackageResponse>\\n <CbnGeographicRegionIdB>Global</CbnGeographicRegionIdB>\\n <CbnGeographicRegionIdA>China-mainland</CbnGeographicRegionIdA>\\n <Description>testDescription</Description>\\n <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>\\n <CreateTime>1578966918000</CreateTime>\\n <Name>testName</Name>\\n <BandwidthType>Basic</BandwidthType>\\n <Type>Basic</Type>\\n <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>\\n <State>active</State>\\n <ChargeType>PREPAY</ChargeType>\\n <Bandwidth>2</Bandwidth>\\n <ExpiredTime>1578966918000</ExpiredTime>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n <RegionId>cn-hangzhou</RegionId>\\n <BillingType>PayByTraffic</BillingType>\\n <Ratio>30</Ratio>\\n</DescribeBandwidthPackageResponse>","errorExample":""}]', + 'title' => '查询带宽包', + 'summary' => '调用DescribeBandwidthPackage接口查询带宽包详细信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListBandwidthPackages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数，最大值为**100**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的状态，取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **binded**：已绑定。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。'."\n" + ."\n" + .'- **locked**：已锁定。', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的类型，取值：'."\n" + ."\n" + .'- **Basic**：基础带宽包。'."\n" + ."\n" + .'- **CrossDomain**：跨地域加速包。'."\n" + ."\n" + .'中国站仅支持取值**Basic**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2ry6mp2c****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '带宽包的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '带宽包的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '带宽包的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页包含的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B6DBBB0-2D01-4C6A-A384-4129266E6B78', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BandwidthPackages' => [ + 'description' => '带宽包详情。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '带宽包的类型。'."\n" + ."\n" + .'- **Basic**：基础带宽包。'."\n" + ."\n" + .'- **CrossDomain**：跨地域加速包。'."\n" + ."\n" + .'中国站仅支持返回**Basic**。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'BandwidthType' => [ + 'description' => '带宽类型。'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。'."\n", + 'type' => 'string', + 'example' => 'Basic', + ], + 'State' => [ + 'description' => '带宽包的状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **binded**：已绑定。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。'."\n" + ."\n" + .'- **locked**：已锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'description' => '带宽包的创建时间。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'ChargeType' => [ + 'description' => '付费类型。'."\n" + .'- **PREPAY**（默认值）：预付费，即包年包月。'."\n" + .'- **POSTPAY**：后付费，即按量付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'RegionId' => [ + 'description' => '全球加速实例所在的地域ID，仅返回**cn-hangzhou**。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CbnGeographicRegionIdA' => [ + 'description' => '跨地域加速包的互通区域A。仅返回为**China-mainland**（中国内地）。'."\n" + ."\n" + .'仅国际站支持返回该参数。', + 'type' => 'string', + 'example' => 'China-mainland', + ], + 'BandwidthPackageId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + 'Bandwidth' => [ + 'description' => '带宽包的带宽值，单位为Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Description' => [ + 'description' => '带宽包的描述。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'ExpiredTime' => [ + 'description' => '带宽包到期时间的时间戳。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'Accelerators' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + 'CbnGeographicRegionIdB' => [ + 'description' => '跨地域加速包的互通区域B。仅返回为**Global**（全球）。'."\n" + ."\n" + .'仅国际站支持返回该参数。', + 'type' => 'string', + 'example' => 'Global', + ], + 'Name' => [ + 'description' => '带宽包的名称。', + 'type' => 'string', + 'example' => 'testName', + ], + 'BillingType' => [ + 'description' => '后付费计费方式。'."\n" + .'- **PayByTraffic**：流量计费。'."\n" + .'- **PayBY95**：95计费。', + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Ratio' => [ + 'description' => '95计费保底百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2ry6mp2c****', + ], + 'Tags' => [ + 'description' => '带宽包的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '带宽包的标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '带宽包的标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4B6DBBB0-2D01-4C6A-A384-4129266E6B78\\",\\n \\"PageNumber\\": 1,\\n \\"BandwidthPackages\\": [\\n {\\n \\"Type\\": \\"Basic\\",\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"State\\": \\"active\\",\\n \\"CreateTime\\": \\"1578966918000\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CbnGeographicRegionIdA\\": \\"China-mainland\\",\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\",\\n \\"Bandwidth\\": 2,\\n \\"Description\\": \\"testDescription\\",\\n \\"ExpiredTime\\": \\"1578966918000\\",\\n \\"Accelerators\\": [\\n \\"ga-bp1qe94o52ot4pkfn****\\"\\n ],\\n \\"CbnGeographicRegionIdB\\": \\"Global\\",\\n \\"Name\\": \\"testName\\",\\n \\"BillingType\\": \\"PayByTraffic\\",\\n \\"Ratio\\": 30,\\n \\"ResourceGroupId\\": \\"rg-aek2ry6mp2c****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListBandwidthPackagesResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>\\n <PageNumber>1</PageNumber>\\n <BandwidthPackages>\\n <Type>Basic</Type>\\n <BandwidthType>Basic</BandwidthType>\\n <State>active</State>\\n <CreateTime>1578966918000</CreateTime>\\n <ChargeType>PREPAY</ChargeType>\\n <RegionId>cn-hangzhou</RegionId>\\n <CbnGeographicRegionIdA>China-mainland</CbnGeographicRegionIdA>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n <Bandwidth>2</Bandwidth>\\n <Description>testDescription</Description>\\n <ExpiredTime>1578966918000</ExpiredTime>\\n <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>\\n <CbnGeographicRegionIdB>Global</CbnGeographicRegionIdB>\\n <Name>testName</Name>\\n <BillingType>PayByTraffic</BillingType>\\n <Ratio>30</Ratio>\\n <ResourceGroupId>rg-aekztkx4zwc3m4a</ResourceGroupId>\\n <Tags>\\n <Key>tag-key</Key>\\n <Value>tag-value</Value>\\n </Tags>\\n </BandwidthPackages>\\n</ListBandwidthPackagesResponse>","errorExample":""}]', + 'title' => '查询带宽包列表', + 'summary' => '调用ListBandwidthPackages接口查询带宽包列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateBandwidthPackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的带宽包的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的名称。'."\n" + .'名称长度为1~128个英文或中文字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的描述信息。'."\n" + ."\n" + .'描述长度最大为256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'testDescription', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的带宽值。单位：Mbps。'."\n" + ."\n" + .'取值范围：**2**~**2000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BandwidthType', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽类型。取值：'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。'."\n" + ."\n" + .'> 目前，仅支持**Basic**与**Enhanced**间变配，不支持**Advanced**与其他类型间进行变配。', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + ."\n" + .' - **false**（默认值）：不开启自动付费。生成订单后需要到<props="china">[订单中心](https://usercenter2.aliyun.com/order/list)</props><props="intl">[订单中心](https://usercenter2-intl.aliyun.com/order/list)</props>完成支付。'."\n" + .'- **true**：开启自动付费，自动支付订单。'."\n" + ."\n" + .'> 本参数仅对升配订单生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用代金券。取值：'."\n" + ."\n" + .'- **true**：使用。'."\n" + ."\n" + .'- **false**（默认值）：不使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'BandwidthPackage' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1eo4f57z1kbbcmn****', + ], + 'Description' => [ + 'description' => '带宽包的描述信息。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DF3A3CB-B621-44F8-9870-C20D034D7AB', + ], + 'Name' => [ + 'description' => '带宽包的名称。', + 'type' => 'string', + 'example' => 'testName', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => 'The Basic type only can be upgraded to the Enhanced, and the Enhanced type only can be downgraded to the Basic . The type of the Advance bandwidth can not be changed.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'UpgradeError.BandwidthPackage', + 'errorMessage' => 'The bandwidth package configurations should be either all upgrades or all downgrades.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BandwidthPackage\\": \\"gbwp-bp1eo4f57z1kbbcmn****\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"RequestId\\": \\"1DF3A3CB-B621-44F8-9870-C20D034D7AB\\",\\n \\"Name\\": \\"testName\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBandwidthPackageResponse>\\n <BandwidthPackage>gbwp-bp1eo4f57z1kbbcmn****</BandwidthPackage>\\n <Description>testDescription</Description>\\n <RequestId>1DF3A3CB-B621-44F8-9870-C20D034D7AB</RequestId>\\n <Name>testName</Name>\\n</UpdateBandwidthPackageResponse>","errorExample":""}]', + 'title' => '修改带宽包的配置', + 'summary' => '调用UpdateBandwidthPackage接口修改带宽包的配置。', + 'description' => '在调用本接口时，请注意以下事项：'."\n" + .'- 不涉及带宽值修改时，**UpdateBandwidthPackage**接口属于同步接口，修改完成后即时生效。'."\n" + .'- 涉及带宽值修改，且该带宽包未绑定全球加速实例时，**UpdateBandwidthPackage**接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未修改完成。系统后台的修改任务仍在进行。您可以调用[DescribeBandwidthPackage](~~153241~~)查询带宽包配置是否完成修改：'."\n" + .' - 当修改的参数值未发生变更，表示带宽包正在修改中，在该情况下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当修改的参数值已发生变更，表示修改完成。'."\n" + .'- 涉及带宽值修改，且该带宽包已绑定全球加速实例时，**UpdateBandwidthPackage**接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未修改完成。系统后台的修改任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)，通过查询全球加速实例的状态，了解带宽包是否修改完成：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示绑定全球加速实例的带宽包正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示绑定全球加速实例的带宽包修改完成。'."\n" + .'- **UpdateBandwidthPackage**接口不支持并发修改同一个带宽包的配置。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReplaceBandwidthPackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要替换的新的带宽包ID。指定带宽包时，请注意：'."\n" + ."\n" + .'- 仅支持指定未绑定任何全球加速实例的带宽包。'."\n" + ."\n" + .'- 如果要替换的带宽包为基础带宽包，请确保要替换的新的基础带宽包的带宽必须大于或等于加速区域中已分配的带宽总额。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp176neb61yhcymow****', + ], + ], + [ + 'name' => 'TargetBandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要被替换的旧的带宽包ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-o978hgeb61yhcymow****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待替换带宽包的全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A0EA8CCA-F081-4338-9790-A1C791CCA779', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A0EA8CCA-F081-4338-9790-A1C791CCA779\\"\\n}","errorExample":""},{"type":"xml","example":"<ReplaceBandwidthPackageResponse>\\n <RequestId>A0EA8CCA-F081-4338-9790-A1C791CCA779</RequestId>\\n</ReplaceBandwidthPackageResponse>","errorExample":""}]', + 'title' => '替换带宽包', + 'summary' => '调用ReplaceBandwidthPackage接口为全球加速实例替换带宽包。', + 'description' => '在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- 替换带宽包不会中断全球加速的转发流量。'."\n" + .'- **ReplaceBandwidthPackage**接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未替换完成，系统后台的替换任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)或[ListAccelerators](~~153236~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示带宽包正在替换中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示带宽包替换完成。'."\n" + .'- **ReplaceBandwidthPackage**接口不支持并发替换同一个全球加速实例的带宽包。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteBandwidthPackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BandwidthPackageId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的带宽包的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'BandwidthPackageId' => [ + 'description' => '需要删除的带宽包的ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'BindExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package is already bound.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBandwidthPackageResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n</DeleteBandwidthPackageResponse>","errorExample":""}]', + 'title' => '删除指定带宽包', + 'summary' => '调用DeleteBandwidthPackage接口删除指定的带宽包。', + 'description' => '- 预付费（包年包月）带宽包默认不支持删除。您可以前往<props="china">[退订管理](https://usercenter2.aliyun.com/refund/refund)</props><props="intl">[退订管理](https://usercenter2-intl.aliyun.com/refund/refund)</props>页面进行退订。退订前，请确保带宽包已与全球加速实例解绑，解绑操作，请参见[BandwidthPackageRemoveAccelerator](~~153240~~)。'."\n" + .'- 当带宽包已绑定全球加速实例时，不支持删除。如需删除，请先将带宽包与全球加速实例解绑，解绑操作，请参见[BandwidthPackageRemoveAccelerator](~~153240~~)。'."\n" + .'- **DeleteBandwidthPackage**接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeBandwidthPackage](~~153241~~)查询带宽包的状态：'."\n" + .' - 当带宽包处于**deleting**状态时，表示带宽包正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该带宽包时，表示带宽包删除完成。'."\n" + .'- **DeleteBandwidthPackage**接口不支持并发删除同一个带宽包。', + ], + 'CreateBandwidthPackage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '7845', + 'abilityTreeNodes' => [ + 'FEATUREga2CVKMC', + 'FEATUREga9TPDL7', + 'FEATUREgaD5ZFDF', + 'FEATUREgaU09R2U', + 'FEATUREgaJIDE8Z', + 'FEATUREgaE0WE9L', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的带宽值。单位：Mbps。'."\n" + .'取值范围：**2**~**2000**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长。'."\n" + .'- 当**PricingCycle**取值**Month**时，**Duration**取值范围为**1**~**9**。'."\n" + .'- 当**PricingCycle**取值**Year**时，**Duration**取值范围为**1**~**3**。'."\n" + ."\n" + .'在**ChargeType**取值为**PREPAY**时，该项不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '计费周期。取值：'."\n" + .'- **Month**：按月计费。'."\n" + .'- **Year**：按年计费。'."\n" + ."\n" + .'在**ChargeType**取值为**PREPAY**时，该项不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + .'- **false**（默认值）：不开启自动付费，生成订单后需要到订单中心完成支付。'."\n" + .'- **true**：开启自动付费，自动支付订单。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的类型。取值：'."\n" + .'- **Basic**：基础带宽包。'."\n" + .'- **CrossDomain**：跨地域加速包。'."\n" + ."\n" + .'中国站仅支持**Basic**。', + 'type' => 'string', + 'required' => true, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'BandwidthType', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽类型。取值：'."\n" + .'- **Basic**：标准加速带宽。'."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + .'- **Advanced**：精品加速带宽。'."\n" + ."\n" + .'在带宽包类型**Type**取值为**Basic**时，该项不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券自动支付账单。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅**AutoPay**为**true**时，该项才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Ratio', + 'in' => 'query', + 'schema' => [ + 'description' => '95计费保底比例。取值范围：**30**~**100**。'."\n" + .'> 仅**BillingType**为**PayBY95**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BillingType', + 'in' => 'query', + 'schema' => [ + 'description' => '后付费计费方式。取值：'."\n" + .'- **PayByTraffic**（默认值）：流量计费。'."\n" + .'- **PayBY95**：95计费。按95计费方式默认不开放，如需使用，请联系您的商务经理申请。'."\n" + .'> 仅**ChargeType**为**POSTPAY**时，该项才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值：'."\n" + .'- **PREPAY**（默认值）：预付费，即包年包月。'."\n" + .'- **POSTPAY**：后付费，即按量付费。后付费类型默认不开放，如需使用，请联系您的商务经理申请。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + 'default' => 'PREPAY', + ], + ], + [ + 'name' => 'CbnGeographicRegionIdA', + 'in' => 'query', + 'schema' => [ + 'description' => '跨地域加速包的互通区域A，仅取值为**China-mainland**（中国内地）。'."\n" + ."\n" + .'仅国际站支持传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'China-mainland', + ], + ], + [ + 'name' => 'CbnGeographicRegionIdB', + 'in' => 'query', + 'schema' => [ + 'description' => '跨地域加速包的互通区域B，仅取值为**Global**（全球）。'."\n" + ."\n" + .'仅国际站支持传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Global', + ], + ], + [ + 'name' => 'PromotionOptionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券号码。'."\n" + ."\n" + .'> 仅国际站涉及该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '50003298014****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长。单位：月。'."\n" + ."\n" + .'取值范围：**1**~**12**。默认值：**1**。'."\n" + ."\n" + .'> 仅**AutoRenew**为**true**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '12', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzrnd67gq****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '带宽包的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '带宽包的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '带宽包的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B6DBBB0-2D01-4C6A-A384-4129266E6B78', + ], + 'BandwidthPackageId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + 'OrderId' => [ + 'description' => '订单ID。'."\n" + ."\n" + .'如果您未自动支付账单，请您前往订单中心完成支付。'."\n" + .'<props="china">仅当ChargeType取值为PREPAY，即付费方式为预付费时，返回该参数。如果AutoPay取值为false，即未开启自动付费时，请前往[订单中心](https://usercenter2.aliyun.com/order/list)完成支付。</props>'."\n" + ."\n" + .'<props="intl">仅当ChargeType取值为PREPAY，即付费方式为预付费时，返回该参数。如果AutoPay取值为false，即未开启自动付费时，请前往[订单中心](https://usercenter2-intl.aliyun.com/order/list)完成支付。</props>', + 'type' => 'string', + 'example' => '208257****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'COMMODITY.INVALID_COMPONENT', + 'errorMessage' => 'The bandwidth parameter is incorrect or out of range', + ], + [ + 'errorCode' => 'MissingParameter.BandwidthType', + 'errorMessage' => 'You must specify BandwidthType.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B6DBBB0-2D01-4C6A-A384-4129266E6B78\\",\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\",\\n \\"OrderId\\": \\"208257****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBandwidthPackageResponse>\\n <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n <OrderId>208257****</OrderId>\\n</CreateBandwidthPackageResponse>","errorExample":""}]', + 'title' => '创建指定带宽包', + 'summary' => '创建指定的带宽包。', + 'description' => '使用全球加速GA（Global Accelerator）服务实现网络加速，您需要创建基础带宽包。基础带宽包支持以下带宽类型：'."\n" + .'- **标准加速带宽**：默认的加速区域和服务区域都位于中国内地，被加速的服务部署在阿里云上。'."\n" + .'- **增强加速带宽**：默认的加速区域和服务区域都位于中国内地，可同时加速阿里云和非阿里云的公网服务。'."\n" + .'- **精品加速带宽**：默认的加速区域和服务区域都位于海外，可同时加速阿里云和非阿里云的公网服务。如果要实现中国内地用户的网络加速，需选择中国香港作为加速地域。'."\n" + ."\n" + .'调用本接口时，请注意以下事项：'."\n" + .'- **CreateBandwidthPackage**接口属于异步接口，即系统会先返回一个带宽包ID，但带宽包并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeBandwidthPackage](~~153241~~)查询带宽包的状态：'."\n" + ."\n" + .' - 当带宽包处于**init**状态时，表示带宽包正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当带宽包处于**active**状态时，表示带宽包创建完成。'."\n" + ."\n" + .'- **CreateBandwidthPackage**接口不支持在同一个全球加速实例内并发创建带宽包。', + ], + 'ListBandwidthackages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数，最大值为**100**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页包含的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B6DBBB0-2D01-4C6A-A384-4129266E6B78', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BandwidthPackages' => [ + 'description' => '带宽包详情。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包详情。', + 'type' => 'object', + 'properties' => [ + 'BandwidthPackageId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + 'Bandwidth' => [ + 'description' => '带宽包的带宽值，单位为Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Description' => [ + 'description' => '带宽包的描述。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'ExpiredTime' => [ + 'description' => '带宽包到期时间的时间戳。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'State' => [ + 'description' => '带宽包的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **binded**：已绑定。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **updating**：更新中。'."\n" + .'- **finacialLocked**：欠费锁定。'."\n" + .'- **locked**：已锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'description' => '带宽包创建时间的时间戳。', + 'type' => 'string', + 'example' => '1578966918000', + ], + 'ChargeType' => [ + 'description' => '付费类型。'."\n" + .'- **PREPAY**（默认值）：预付费，即包年包月。'."\n" + .'- **POSTPAY**：后付费，即按量付费。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'Accelerators' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '带宽包绑定的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1qe94o52ot4pkfn****', + ], + ], + 'Name' => [ + 'description' => '全球加速实例的名称。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'RegionId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzzwgr7vz2liy', + ], + 'Tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4B6DBBB0-2D01-4C6A-A384-4129266E6B78\\",\\n \\"PageNumber\\": 1,\\n \\"BandwidthPackages\\": [\\n {\\n \\"BandwidthPackageId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\",\\n \\"Bandwidth\\": 2,\\n \\"Description\\": \\"testDescription\\",\\n \\"ExpiredTime\\": \\"1578966918000\\",\\n \\"State\\": \\"active\\",\\n \\"CreateTime\\": \\"1578966918000\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"Accelerators\\": [\\n \\"ga-bp1qe94o52ot4pkfn****\\"\\n ],\\n \\"Name\\": \\"Accelerator\\",\\n \\"RegionId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"ResourceGroupId\\": \\"rg-aekzzwgr7vz2liy\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListBandwidthackagesResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>\\n <PageNumber>1</PageNumber>\\n <BandwidthPackages>\\n <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>\\n <Bandwidth>2</Bandwidth>\\n <Description>testDescription</Description>\\n <ExpiredTime>1578966918000</ExpiredTime>\\n <State>active</State>\\n <CreateTime>1578966918000</CreateTime>\\n <ChargeType>PREPAY</ChargeType>\\n <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>\\n <Name>Accelerator</Name>\\n <RegionId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RegionId>\\n </BandwidthPackages>\\n</ListBandwidthackagesResponse>","errorExample":""}]', + 'title' => '获取带宽包列表', + 'summary' => '调用ListBandwidthackages接口获取带宽包列表。', + 'description' => '本接口即将废弃，请使用[ListBandwidthPackages](~~2253239~~)。', + ], + 'DescribeBandwidthPackageAutoRenewAttribute' => [ + 'summary' => '调用DescribeBandwidthPackageAutoRenewAttribute接口查询带宽包自动续费状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1iquvlp8khla5emb3ia', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '自动续费状态对象', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1iquvlp8khla5emb3ia', + ], + 'AutoRenew' => [ + 'description' => '是否开启了自动续费。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoRenewDuration' => [ + 'description' => '自动续费时长。单位：月。取值范围：**1**~**12**。'."\n" + ."\n" + .'> 仅**AutoRenew**为**true**时，该项生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => '带宽包的自动续费状态。'."\n" + ."\n" + .'- **AutoRenewal**：自动续费。'."\n" + ."\n" + .'- **Normal**：手动续费。'."\n" + ."\n" + .'- **NotRenewal**：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。不再续费的带宽包可以修改成手动续费（**Normal**）后，再自行续费或配置为自动续费（**AutoRenewal**）。'."\n" + ."\n" + .'> 参数**RenewalStatus**的优先级高于参数**AutoRenew**。如果不配置参数**RenewalStatus**，则默认以参数**AutoRenew**为准。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B820E9F9-D459-5AE7-8F08-A368B53C1AC3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"gbwp-bp1iquvlp8khla5emb3ia\\",\\n \\"AutoRenew\\": false,\\n \\"AutoRenewDuration\\": 1,\\n \\"RenewalStatus\\": \\"Normal\\",\\n \\"RequestId\\": \\"B820E9F9-D459-5AE7-8F08-A368B53C1AC3\\"\\n}","type":"json"}]', + 'title' => '查询包年包月带宽包自动续费状态', + ], + 'UpdateBandwidthPackagaAutoRenewAttribute' => [ + 'summary' => '调用UpdateBandwidthPackagaAutoRenewAttribute接口修改带宽包的自动续费属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的名称。'."\n" + ."\n" + .'名称长度为2~128个英文或中文字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'>**AutoRenew**和**RenewalStatus**不能同时为空。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽包的自动续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：设置为自动续费。'."\n" + ."\n" + .'- **Normal**：手动续费。'."\n" + ."\n" + .'- **NotRenewal**：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。不再续费的带宽包可以修改成手动续费（Normal）后，再自行续费或配置为自动续费（**AutoRenewal**）。'."\n" + ."\n" + .'> - **AutoRenew**和**RenewalStatus**不能同时为空。'."\n" + .'> - **RenewalStatus**的优先级高于**AutoRenew**。如果不配置**RenewalStatus**，则默认以**AutoRenew**为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长。单位：月。取值范围：**1**~**12**。'."\n" + ."\n" + .'> 仅**AutoRenew**的为**true**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'InstanceId' => [ + 'description' => '带宽包ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1sgzldyj6b4q7cx****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'ParamIllegal.SpInstanceAutoRenew', + 'errorMessage' => 'The param AutoRenew and RenewalStatus cannot be empty at the same time.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"InstanceId\\": \\"gbwp-bp1sgzldyj6b4q7cx****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBandwidthPackagaAutoRenewAttributeResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <InstanceId>gbwp-bp1sgzldyj6b4q7cx****</InstanceId>\\n</UpdateBandwidthPackagaAutoRenewAttributeResponse>","errorExample":""}]', + 'title' => '修改带宽包的自动续费属性', + 'description' => '**UpdateBandwidthPackagaAutoRenewAttribute**接口不支持并发修改同一个带宽包的自动续费属性。', + ], + 'ListIspTypes' => [ + 'summary' => '调用ListIspTypes接口查询加速地域支持的公网线路类型。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BusinessRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的加速地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorType', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的全球加速实例类型。取值：'."\n" + .'- **basic**：基础型全球加速实例。'."\n" + .'- **standard**：标准型全球加速实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'IspTypeList' => [ + 'description' => '加速地域公网线路类型。'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。'."\n" + ."\n" + .'如果您是单线带宽的白名单用户，您还可能返回以下类型：'."\n" + .'- **ChinaTelecom**：中国电信（单线）'."\n" + .'- **ChinaUnicom**：中国联通（单线）'."\n" + .'- **ChinaMobile**：中国移动（单线）'."\n" + .'- **ChinaTelecom_L2**：中国电信（单线）\\_L2'."\n" + .'- **ChinaUnicom_L2**：中国联通（单线）\\_L2'."\n" + .'- **ChinaMobile_L2**：中国移动（单线）\\_L2'."\n" + ."\n" + .'> 加速地域不同，支持的单线线路类型不同。', + 'type' => 'array', + 'items' => [ + 'description' => '加速地域公网线路类型。'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。'."\n" + ."\n" + .'如果您是单线带宽的白名单用户，您还可能返回以下类型：'."\n" + .'- **ChinaTelecom**：中国电信（单线）'."\n" + .'- **ChinaUnicom**：中国联通（单线）'."\n" + .'- **ChinaMobile**：中国移动（单线）'."\n" + .'- **ChinaTelecom_L2**：中国电信（单线）\\_L2'."\n" + .'- **ChinaUnicom_L2**：中国联通（单线）\\_L2'."\n" + .'- **ChinaMobile_L2**：中国移动（单线）\\_L2'."\n" + ."\n" + .'> 加速地域不同，支持的单线线路类型不同。', + 'type' => 'string', + 'example' => 'BGP', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"IspTypeList\\": [\\n \\"BGP\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListIspTypesResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <IspTypeList>BGP</IspTypeList>\\n</ListIspTypesResponse>","errorExample":""}]', + 'title' => '查询加速地域支持的公网线路类型', + ], + 'UpdateAcceleratorCrossBorderMode' => [ + 'summary' => '调用UpdateAcceleratorCrossBorderMode接口修改全球加速实例的传输网络质量类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161146', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'enum' => [], + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。'."\n" + ."\n" + .'> 该全球加速实例需为按流量的带宽计费方式。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + 'enum' => [], + ], + ], + [ + 'name' => 'CrossBorderMode', + 'in' => 'query', + 'schema' => [ + 'title' => '取值：bgpPro|private，'."\n" + .'bgpPro：精品公网跨境，借助优质的公网线路实现跨境访问'."\n" + .'private：联通专线跨境模式，此模式需要完成跨境资质审核', + 'description' => '全球加速实例的传输网络质量类型。取值：'."\n" + ."\n" + .'<props="china">'."\n" + .'- **bgpPro**：精品带宽跨境加速。使用BGP精品线路，实现跨境网络加速。相比联通专线跨境，简化了跨境资质审批流程。</props>'."\n" + .'<props="china">'."\n" + .'- **private**：联通跨境专线加速。使用联通专线线路，相比精品带宽跨境，加速效果更好，但需要进行跨境合规认证，申请联通跨境业务资质。</props>'."\n" + .'<props="intl">'."\n" + .'- **bgpPro**：精品带宽跨域加速。使用BGP精品线路，实现跨境网络加速。相比跨域专线线路，简化了企业实名登记流程。</props>'."\n" + .'<props="intl">'."\n" + .'- **private**：专线跨域加速。使用跨域专线线路，相比精品带宽跨域，加速效果更好，但需要进行企业实名认证。</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'bgpPro', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotSupportChangeCrossBorderMode.Accelerator', + 'errorMessage' => 'Currently Accelerator does not support to update cross-border mode.', + ], + [ + 'errorCode' => 'Error.ComplianceIssue', + 'errorMessage' => 'The current instance is not allowed to use the cross-border special line before obtaining cross-border qualification.', + ], + [ + 'errorCode' => 'CrossBorderStatusNotOpen.Accelerator', + 'errorMessage' => 'The cross-border mode does not allow modification because the cross-border switch is not turned on.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAcceleratorCrossBorderModeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateAcceleratorCrossBorderModeResponse>","errorExample":""}]', + 'title' => '修改全球加速实例的传输网络质量类型', + 'description' => '本接口用于修改带宽计费方式为**按流量**的**标准型**全球加速实例的传输网络质量类型。修改传输网络质量类型前，请确保您已完成以下操作：'."\n" + .'- 您已开通云数据传输CDT（Cloud DataTransfer）服务。调用[CreateAccelerator](~~206786~~)，参数**BandwidthBillingType**（带宽计费方式）配置为**CDT**，创建带宽计费方式为**按流量**的**标准型**全球加速实例时，系统将自动为您开通CDT服务，流量费用由CDT统一结算。'."\n" + .'<props="china">'."\n" + .'- 如果您需要修改全球加速实例的传输网络质量类型为联通跨境专线加速，即**CrossBorderMode**取值为**private**，您必须先完成跨境合规认证。请在[联通跨境云专线在线申请](https://ecommerce.ictsoft.cn/apply/)页面提交资料，申请联通跨境业务资质。</props>'."\n" + .'<props="intl">'."\n" + .'- 如果您需要修改全球加速实例的传输网络质量类型为专线跨域加速，即**CrossBorderMode**取值为**private**，需确保当前账号已完成企业实名登记。具体操作，请参见[如何进行实名登记？](~~52595~~)。</props>', + ], + 'UpdateAcceleratorCrossBorderStatus' => [ + 'summary' => '开启全球加速实例的跨境传输服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172921', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。'."\n" + ."\n" + .'> 该全球加速实例需为按流量的带宽计费方式。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'CrossBorderStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例是否开启跨境线路功能。取值：'."\n" + ."\n" + .'- **true**：开启跨境线路功能，可以加速跨境线路。'."\n" + ."\n" + .'- **false**：关闭跨境线路功能，不可以加速跨境线路。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CrossBorderStatusUnsupported.Accelerator', + 'errorMessage' => 'The current instance does not support enabling or disabling the cross-border switch.', + ], + [ + 'errorCode' => 'CrossBorderStatusTurnOffInvalid.Accelerator', + 'errorMessage' => 'If there are any cross-border lines, it is not allowed to turn off the cross-border switch.', + ], + [ + 'errorCode' => 'Error.ComplianceIssue', + 'errorMessage' => 'The current instance is not allowed to use the cross-border special line before obtaining cross-border qualification.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotOpen.CrossBorderStatus', + 'errorMessage' => 'Cross-border acceleration has not been enabled for the instance.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '开启全球加速实例的跨境传输服务', + 'description' => '对于计划采用云数据传输CDT（Cloud DataTransfer）服务进行计费的基础型或标准型全球加速实例，本接口用于开启或关闭该实例的跨境传输服务。', + ], + 'CreateAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '7844', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长。'."\n" + ."\n" + .'- 当**PricingCycle**取值**Month**时，**Duration**取值范围为**1**~**9**。'."\n" + ."\n" + .'- 当**PricingCycle**取值**Year**时，**Duration**取值范围为**1**~**3**。'."\n" + .'> **InstanceChargeTyp**e（全球加速实例计费方式）为**PREPAY**（预付费）时，该项必须配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '计费周期。取值：'."\n" + ."\n" + .'- **Month**：按月计费。'."\n" + .'- **Year**：按年计费。'."\n" + .'> **InstanceChargeTyp**e（全球加速实例计费方式）为**PREPAY**（预付费）时，该项必须配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'enum' => [ + 'Year', + 'Month', + 'Day', + 'Hour', + ], + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的规格，取值：'."\n" + ."\n" + .'- **1**：小型Ⅰ。'."\n" + .'- **2**：小型Ⅱ。'."\n" + .'- **3**：小型Ⅲ。'."\n" + .'- **5**：中型Ⅰ。'."\n" + .'- **8**：中型Ⅱ。'."\n" + .'- **10**：中型Ⅲ。'."\n" + .'- **20**：大型Ⅰ。'."\n" + .'- **30**：大型Ⅱ。'."\n" + .'- **40**：大型Ⅲ。'."\n" + .'- **50**：大型IV。'."\n" + .'- **60**：大型V。'."\n" + .'- **70**：大型VI。'."\n" + .'- **80**：大型VII。'."\n" + .'- **90**：大型VIII。'."\n" + .'- **100**：超大型Ⅰ。'."\n" + .'- **200**：超大型Ⅱ。'."\n" + ."\n" + .'> - 目前，大型Ⅲ及以上规格仅白名单开放。如需使用，请联系阿里云客户经理。'."\n" + .'> - **InstanceChargeTyp**e（全球加速实例计费方式）为**PREPAY**（预付费）时，该项必须配置。'."\n" + ."\n" + .'实例规格不同，定义也不同。更多信息，请参见[实例规格](~~153127~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值：'."\n" + ."\n" + .'- **false**（默认值）：不开启自动付费，生成订单后需要到订单中心完成支付。'."\n" + ."\n" + .'- **true**：开启自动付费，自动支付订单。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券自动支付账单。取值：'."\n" + ."\n" + .'- **true**：使用。'."\n" + .'- **false**（默认值）：不使用。'."\n" + ."\n" + .'>仅**AutoPay**为**true**时，该项才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长。单位：月。'."\n" + ."\n" + .'取值范围：**1**~**12**。默认值：**1**。'."\n" + ."\n" + .'> 仅**AutoRenew**为**true**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PromotionOptionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券号码。'."\n" + ."\n" + .'> 仅国际站涉及该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '50003298014****', + ], + ], + [ + 'name' => 'BandwidthBillingType', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽计费方式。'."\n" + ."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + .'- **CDT**：按流量计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'BandwidthPackage', + ], + ], + [ + 'name' => 'IpSetConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '加速区域配置。', + 'type' => 'object', + 'properties' => [ + 'AccessMode' => [ + 'description' => '加速区域接入模式。取值：'."\n" + ."\n" + .'- **UserDefine**：自定义就近接入模式。您可以根据业务需要，定向选择加速区域和地域，全球加速为每个加速地域提供独立的EIP。'."\n" + .'- **Anycast**：采用自动就近接入模式。您无需配置加速区域。全球加速在全球多地域提供一个Anycast EIP，用户可通过Anycast EIP从就近接入点进入阿里云加速网络。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'UserDefine', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '标准型全球加速实例所属资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzrnd67gq****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '全球加速实例的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '全球加速实例的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '全球加速实例的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例付费类型。'."\n" + .'- PREPAY（默认值）：预付费。'."\n" + .'- POSTPAY： 后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '标准型全球加速实例带宽。单位：**Mbps**。'."\n" + ."\n" + .'取值范围：200~5000。'."\n" + .'> 仅加速区域接入模式为Anycast时有效，且必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'OrderId' => [ + 'description' => '订单ID。'."\n" + ."\n" + .'<props="china">当InstanceChargeType（付费类型）取值为PREPAY（预付费）时，返回该参数。如果AutoPay取值为false，即未开启自动支付账单时，请前往[订单中心](https://usercenter2.aliyun.com/order/list)完成支付。</props>'."\n" + ."\n" + .'<props="intl">当InstanceChargeType（付费类型）取值为PREPAY（预付费）时，返回该参数。如果AutoPay取值为false，即未开启自动支付账单时，请前往[订单中心](https://usercenter2-intl.aliyun.com/order/list)完成支付。</props>', + 'type' => 'string', + 'example' => '208257****', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"OrderId\\": \\"208257****\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAcceleratorResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <OrderId>208257****</OrderId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n</CreateAcceleratorResponse>","errorExample":""}]', + 'title' => '创建一个全球加速实例', + 'summary' => '全球加速 GA（Global Accelerator）是一款覆盖全球的网络加速服务，依托阿里云优质BGP带宽和全球传输网络，实现全球网络就近接入，可以减少延迟、抖动、丢包等网络问题对服务质量的影响，为全球用户提供高可用和高性能的网络加速服务，您可以通过调用CreateAccelerator接口创建一个全球加速实例。', + 'description' => '**CreateAccelerator**接口属于异步接口，即系统会先返回一个全球加速实例ID，但该全球加速实例尚未创建成功，系统后台的创建任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)查询全球加速实例的状态：'."\n" + ."\n" + .'- 当全球加速实例处于**init**状态时，表示全球加速实例正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .'- 当全球加速实例处于**active**状态时，表示全球加速实例创建完成。', + ], + 'DescribeAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7855', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + 'DnsName' => [ + 'description' => '全球加速实例分配的CNAME地址。', + 'type' => 'string', + 'example' => 'ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com', + ], + 'Description' => [ + 'description' => '全球加速实例的描述信息。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + 'InstanceChargeType' => [ + 'description' => '全球加速实例的计费方式。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'CreateTime' => [ + 'description' => '全球加速实例创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1650643200', + ], + 'CrossDomainBandwidthPackage' => [ + 'description' => '全球加速实例绑定的跨地域加速包的详情。'."\n" + ."\n" + .'仅国际站支持返回该数组。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'description' => '跨地域加速包的带宽值，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'InstanceId' => [ + 'description' => '跨地域加速包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'SecondDnsName' => [ + 'description' => '全球加速联动DDoS高防实例的CNAME。', + 'type' => 'string', + 'example' => 'ga-bp1f609c76zg6zuna****-1.aliyunga0047.com', + ], + 'Name' => [ + 'description' => '全球加速实例的名称。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'BasicBandwidthPackage' => [ + 'description' => '全球加速实例绑定的基础带宽包的详情。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'description' => '基础带宽包的带宽值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BandwidthType' => [ + 'description' => '基础带宽包的带宽类型。取值：'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'InstanceId' => [ + 'description' => '基础带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'State' => [ + 'description' => '全球加速实例的状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'ExpiredTime' => [ + 'description' => '全球加速实例到期时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200', + ], + 'CenId' => [ + 'description' => '全球加速实例绑定的云企业网实例ID。', + 'type' => 'string', + 'example' => 'cen-hjkduu767hc****', + ], + 'RegionId' => [ + 'description' => '全球加速实例所在的地域。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cn-hangzhou', + ], + 'Spec' => [ + 'description' => '全球加速实例的规格，取值：'."\n" + ."\n" + .'- **1**：小型Ⅰ。'."\n" + .'- **2**：小型Ⅱ。'."\n" + .'- **3**：小型Ⅲ。'."\n" + .'- **5**：中型Ⅰ。'."\n" + .'- **8**：中型Ⅱ。'."\n" + .'- **10**：中型Ⅲ。'."\n" + .'- **20**：大型Ⅰ。'."\n" + .'- **30**：大型Ⅱ。'."\n" + .'- **40**：大型Ⅲ。'."\n" + .'- **50**：大型IV。'."\n" + .'- **60**：大型V。'."\n" + .'- **70**：大型VI。'."\n" + .'- **80**：大型VII。'."\n" + .'- **90**：大型VIII。'."\n" + .'- **100**：超大型Ⅰ。'."\n" + .'- **200**：超大型Ⅱ。'."\n" + ."\n" + .'> 目前，大型Ⅲ及以上规格仅白名单开放。如需使用，请联系阿里云客户经理。'."\n" + ."\n" + .'实例规格不同，定义也不同。更多信息，请参见[实例规格](~~153127~~)。', + 'type' => 'string', + 'example' => '1', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'BandwidthBillingType' => [ + 'description' => '带宽计费方式。取值：'."\n" + ."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + ."\n" + .'- **CDT**：按流量计费。', + 'type' => 'string', + 'example' => 'CDT', + ], + 'IpSetConfig' => [ + 'description' => '加速区域配置。', + 'type' => 'object', + 'properties' => [ + 'AccessMode' => [ + 'description' => '加速区域接入模式。取值：'."\n" + ."\n" + .'- **UserDefine**：自定义就近接入模式。您可以根据业务需要，定向选择加速区域和地域，全球加速为每个加速地域提供独立的EIP。'."\n" + .'- **Anycast**：采用自动就近接入模式。您无需配置加速区域。全球加速在全球多地域提供一个Anycast EIP，用户可通过Anycast EIP从就近接入点进入阿里云加速网络。'."\n", + 'type' => 'string', + 'example' => 'UserDefine', + ], + ], + ], + 'CrossPrivateState' => [ + 'description' => '是否开启了跨地域带宽跨境。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'string', + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmw2vwdbujqbq', + ], + 'Tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + 'CrossBorderMode' => [ + 'title' => '当前实例的跨境网络类型，用于按量付费实例，显示其是用专线跨境还是精品公网跨境', + 'description' => '用于带宽计费方式为按流量计费（CDT）的实例，显示其跨境加速类型，取值：'."\n" + ."\n" + .'**bpgPro**：精品带宽跨境加速。', + 'type' => 'string', + 'example' => 'bpgPro', + ], + 'CrossBorderStatus' => [ + 'description' => '全球加速实例是否开启跨境线路功能。取值：'."\n" + ."\n" + .'- **true**：开启跨境线路功能，可以加速跨境线路。'."\n" + ."\n" + .'- **false**：关闭跨境线路功能，不可以加速跨境线路。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UpgradableStatus' => [ + 'title' => 'ga实例升级状态', + 'description' => '全球加速实例的可升级状态。取值：'."\n" + .'- **notUpgradable**：当前实例不需要升级。'."\n" + .'- **upgradable**：当前实例可升级至最新版本。'."\n" + .'- **upgradeFailed**：当前实例执行过升级操作且升级失败。', + 'type' => 'string', + 'example' => 'notUpgradable', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + ."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + ."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'DdosConfigList' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例ID。', + 'type' => 'string', + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + 'DdosRegionId' => [ + 'description' => 'DDoS高防实例所在的地域，取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中国内地。'."\n" + ."\n" + .'- **ap-southeast-1**：非中国内地。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + ], + ], + ], + 'Bandwidth' => [ + 'description' => '标准型全球加速实例带宽。单位：Mbps。'."\n" + .'> 仅加速区域接入模式为Anycast时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DdosId\\": \\"ddoscoo-cn-zz11vq7j****\\",\\n \\"DnsName\\": \\"ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com\\",\\n \\"Description\\": \\"Accelerator\\",\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\",\\n \\"InstanceChargeType\\": \\"PREPAY\\",\\n \\"CreateTime\\": 1650643200,\\n \\"CrossDomainBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"SecondDnsName\\": \\"ga-bp1f609c76zg6zuna****-1.aliyunga0047.com\\",\\n \\"Name\\": \\"Accelerator\\",\\n \\"BasicBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"State\\": \\"active\\",\\n \\"ExpiredTime\\": 1653235200,\\n \\"CenId\\": \\"cen-hjkduu767hc****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Spec\\": \\"1\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"BandwidthBillingType\\": \\"CDT\\",\\n \\"IpSetConfig\\": {\\n \\"AccessMode\\": \\"UserDefine\\"\\n },\\n \\"CrossPrivateState\\": \\"false\\",\\n \\"ResourceGroupId\\": \\"rg-acfmw2vwdbujqbq\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ],\\n \\"CrossBorderMode\\": \\"bpgPro\\",\\n \\"CrossBorderStatus\\": false,\\n \\"UpgradableStatus\\": \\"notUpgradable\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"DdosConfigList\\": [\\n {\\n \\"DdosId\\": \\"ddoscoo-cn-zz11vq7j****\\",\\n \\"DdosRegionId\\": \\"ap-southeast-1\\"\\n }\\n ],\\n \\"Bandwidth\\": 200\\n}","errorExample":""},{"type":"xml","example":"<DescribeAcceleratorResponse>\\n <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>\\n <DnsName>ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com</DnsName>\\n <Description>Accelerator</Description>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n <InstanceChargeType>PREPAY</InstanceChargeType>\\n <CreateTime>1650643200</CreateTime>\\n <CrossDomainBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </CrossDomainBandwidthPackage>\\n <SecondDnsName>ga-bp1f609c76zg6zuna****-1.aliyunga0047.com</SecondDnsName>\\n <Name>Accelerator</Name>\\n <BasicBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <BandwidthType>Basic</BandwidthType>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </BasicBandwidthPackage>\\n <State>active</State>\\n <ExpiredTime>1653235200</ExpiredTime>\\n <CenId>cen-hjkduu767hc****</CenId>\\n <RegionId>cn-hangzhou</RegionId>\\n <Spec>1</Spec>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <BandwidthBillingType>CDT</BandwidthBillingType>\\n <IpSetConfig>\\n <AccessMode>UserDefine</AccessMode>\\n </IpSetConfig>\\n <CrossPrivateState>false</CrossPrivateState>\\n <ResourceGroupId>rg-acfmw2vwdbujqbq</ResourceGroupId>\\n <Tags>\\n <Key>tag-key</Key>\\n <Value>tag-value</Value>\\n </Tags>\\n <CrossBorderMode>private</CrossBorderMode>\\n</DescribeAcceleratorResponse>","errorExample":""}]', + 'title' => '查询指定的全球加速实例信息', + 'summary' => '调用DescribeAccelerator接口查询指定的全球加速实例信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAccelerators' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8882', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的状态。取值：'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekztkx4zwc****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '全球加速资源的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '全球加速资源的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'Accelerators' => [ + 'description' => '全球加速实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例信息。', + 'type' => 'object', + 'properties' => [ + 'DnsName' => [ + 'description' => '全球加速实例分配的CNAME地址。', + 'type' => 'string', + 'example' => 'ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com', + ], + 'Type' => [ + 'description' => '无效参数。', + 'type' => 'string', + 'example' => 'None', + ], + 'SecondDnsName' => [ + 'description' => '全球加速与DDoS高防联动后分配的CNAME。', + 'type' => 'string', + 'example' => 'ga-bp1f609c76zg6zuna****-1.aliyunga0047.com', + ], + 'Spec' => [ + 'description' => '全球加速实例的规格，取值：'."\n" + ."\n" + .'- **1**：小型Ⅰ。'."\n" + .'- **2**：小型Ⅱ。'."\n" + .'- **3**：小型Ⅲ。'."\n" + .'- **5**：中型Ⅰ。'."\n" + .'- **8**：中型Ⅱ。'."\n" + .'- **10**：中型Ⅲ。'."\n" + .'- **20**：大型Ⅰ。'."\n" + .'- **30**：大型Ⅱ。'."\n" + .'- **40**：大型Ⅲ。'."\n" + .'- **50**：大型IV。'."\n" + .'- **60**：大型V。'."\n" + .'- **70**：大型VI。'."\n" + .'- **80**：大型VII。'."\n" + .'- **90**：大型VIII。'."\n" + .'- **100**：超大型Ⅰ。'."\n" + .'- **200**：超大型Ⅱ。'."\n" + ."\n" + .'> 目前，大型Ⅲ及以上规格仅白名单开放。如需使用，请联系阿里云客户经理。'."\n" + ."\n" + .'实例规格不同，定义也不同。更多信息，请参见[实例规格](~~153127~~)。', + 'type' => 'string', + 'example' => '1', + ], + 'State' => [ + 'description' => '全球加速实例的状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'description' => '全球加速实例创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1650643200', + ], + 'CenId' => [ + 'description' => '全球加速实例绑定的云企业网实例。', + 'type' => 'string', + 'example' => 'cen-hjfufhjfuwff****', + ], + 'DdosId' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + 'BasicBandwidthPackage' => [ + 'description' => '全球加速实例绑定的基础带宽包的详情。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'description' => '基础带宽包的带宽值，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BandwidthType' => [ + 'description' => '基础带宽包的带宽类型。取值：'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'InstanceId' => [ + 'description' => '基础带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'RegionId' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cn-hangzhou', + ], + 'InstanceChargeType' => [ + 'description' => '全球加速实例的计费方式。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'Description' => [ + 'description' => '全球加速实例的描述信息。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'Bandwidth' => [ + 'description' => '全球加速实例的带宽，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'BandwidthBillingType' => [ + 'description' => '带宽计费方式。'."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + .'- **CDT**：按流量计费。', + 'type' => 'string', + 'example' => 'CDT', + ], + 'ExpiredTime' => [ + 'description' => '全球加速实例到期时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653235200', + ], + 'Name' => [ + 'description' => '全球加速实例的名称。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'CrossDomainBandwidthPackage' => [ + 'description' => '全球加速实例绑定的跨地域加速包的详情。'."\n" + ."\n" + .'仅国际站返回该数组。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'description' => '跨地域加速包的带宽值，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'InstanceId' => [ + 'description' => '跨地域加速包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'IpSetConfig' => [ + 'title' => '加速区配置', + 'description' => '加速区域配置。', + 'type' => 'object', + 'properties' => [ + 'AccessMode' => [ + 'title' => '加速区接入方式', + 'description' => '加速区域接入模式。取值：'."\n" + ."\n" + .'- **UserDefine**：自定义就近接入模式。您可以根据业务需要，定向选择加速区域和地域，全球加速为每个加速地域提供独立的EIP。'."\n" + .'- **Anycast**：采用自动就近接入模式。您无需配置加速区域。全球加速在全球多地域提供一个Anycast EIP，用户可通过Anycast EIP从就近接入点进入阿里云加速网络。'."\n", + 'type' => 'string', + 'example' => 'UserDefine', + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekztkx4zwc****', + ], + 'Tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'test-key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tast-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + 'CrossBorderMode' => [ + 'description' => '用于带宽计费方式为按流量计费（CDT）的实例，显示其跨境加速类型，取值：'."\n" + .'- **bpgPro**：精品带宽跨境加速。'."\n" + .'- **private**：<props="china">联通跨境专线加速。</props><props="intl">专线跨域加速。</props>', + 'type' => 'string', + 'example' => 'bpgPro', + ], + 'CrossBorderStatus' => [ + 'description' => '全球加速实例是否开启跨境线路功能。取值：'."\n" + ."\n" + .'- **true**：开启跨境线路功能，可以加速跨境线路。'."\n" + ."\n" + .'- **false**：关闭跨境线路功能，不可以加速跨境线路。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UpgradableStatus' => [ + 'title' => 'ga实例的升级状态', + 'description' => '全球加速实例的可升级状态。取值：'."\n" + .'- **notUpgradable**：当前实例不需要升级。'."\n" + .'- **upgradable**：当前实例可升级至最新版本。'."\n" + .'- **upgradeFailed**：当前实例执行过升级操作且升级失败。', + 'type' => 'string', + 'example' => 'notUpgradable', + ], + 'ServiceId' => [ + 'title' => 'ga实例的升级状态', + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + ."\n" + .'- **Create**：创建实例。'."\n" + ."\n" + .'- **Update**：更新当前实例。'."\n" + ."\n" + .'- **Delete**：删除当前实例。'."\n" + ."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + ."\n" + .'- **UserUnmanaged**：用户解托管实例'."\n" + ."\n" + .'- **CreateChild**：在当前实例下创建子资源', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + ."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + ."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'DdosConfigList' => [ + 'description' => 'DDoS高防配置文件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => 'DDoS高防ID。', + 'type' => 'string', + 'example' => 'ddoscoo-cn-a8w4ekcb**', + ], + 'DdosRegionId' => [ + 'description' => 'DDoS高防所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '当前实例的跨境网络类型，用于按量付费实例，显示其是用专线跨境还是精品公网跨境', + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"Accelerators\\": [\\n {\\n \\"DnsName\\": \\"ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com\\",\\n \\"Type\\": \\"None\\",\\n \\"SecondDnsName\\": \\"ga-bp1f609c76zg6zuna****-1.aliyunga0047.com\\",\\n \\"Spec\\": \\"1\\",\\n \\"State\\": \\"active\\",\\n \\"CreateTime\\": 1650643200,\\n \\"CenId\\": \\"cen-hjfufhjfuwff****\\",\\n \\"DdosId\\": \\"ddoscoo-cn-zz11vq7j****\\",\\n \\"BasicBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceChargeType\\": \\"PREPAY\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"Description\\": \\"Accelerator\\",\\n \\"Bandwidth\\": 5,\\n \\"BandwidthBillingType\\": \\"CDT\\",\\n \\"ExpiredTime\\": 1653235200,\\n \\"Name\\": \\"Accelerator\\",\\n \\"CrossDomainBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"IpSetConfig\\": {\\n \\"AccessMode\\": \\"UserDefine\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-aekztkx4zwc****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"tast-value\\"\\n }\\n ],\\n \\"CrossBorderMode\\": \\"bpgPro\\",\\n \\"CrossBorderStatus\\": false,\\n \\"UpgradableStatus\\": \\"notUpgradable\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"DdosConfigList\\": [\\n {\\n \\"DdosId\\": \\"ddoscoo-cn-a8w4ekcb**\\",\\n \\"DdosRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListAcceleratorsResponse>\\n <TotalCount>10</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>\\n <Accelerators>\\n <DnsName>ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com</DnsName>\\n <Type>无效参数</Type>\\n <SecondDnsName>ga-bp1f609c76zg6zuna****-1.aliyunga0047.com</SecondDnsName>\\n <Spec>1</Spec>\\n <State>active</State>\\n <CreateTime>1650643200</CreateTime>\\n <CenId>cen-hjfufhjfuwff****</CenId>\\n <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>\\n <BasicBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <BandwidthType>Basic</BandwidthType>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </BasicBandwidthPackage>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceChargeType>PREPAY</InstanceChargeType>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <Description>Accelerator</Description>\\n <Bandwidth>5</Bandwidth>\\n <BandwidthBillingType>CDT</BandwidthBillingType>\\n <ExpiredTime>1653235200</ExpiredTime>\\n <Name>Accelerator</Name>\\n <CrossDomainBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </CrossDomainBandwidthPackage>\\n <IpSetConfig>\\n <AccessMode>UserDefine</AccessMode>\\n </IpSetConfig>\\n <ResourceGroupId>rg-aekztkx4zwc****</ResourceGroupId>\\n <Tags>\\n <Key>test-key</Key>\\n <Value>tast-value</Value>\\n </Tags>\\n <CrossBorderMode>bpgPro</CrossBorderMode>\\n <CrossBorderStatus>false</CrossBorderStatus>\\n <UpgradableStatus>notUpgradable</UpgradableStatus>\\n </Accelerators>\\n <PageNumber>1</PageNumber>\\n</ListAcceleratorsResponse>","errorExample":""}]', + 'title' => '查询全球加速实例列表', + 'summary' => '查询全球加速实例列表。', + ], + 'UpdateAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8892', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Accelerator', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的描述信息，描述长度最大为200个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'Accelerator', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的规格，取值：'."\n" + ."\n" + .'- **1**：小型Ⅰ。'."\n" + .'- **2**：小型Ⅱ。'."\n" + .'- **3**：小型Ⅲ。'."\n" + .'- **5**：中型Ⅰ。'."\n" + .'- **8**：中型Ⅱ。'."\n" + .'- **10**：中型Ⅲ。'."\n" + .'- **20**：大型Ⅰ。'."\n" + .'- **30**：大型Ⅱ。'."\n" + .'- **40**：大型Ⅲ。'."\n" + .'- **50**：大型IV。'."\n" + .'- **60**：大型V。'."\n" + .'- **70**：大型VI。'."\n" + .'- **80**：大型VII。'."\n" + .'- **90**：大型VIII。'."\n" + .'- **100**：超大型Ⅰ。'."\n" + .'- **200**：超大型Ⅱ。'."\n" + ."\n" + .'> 目前，大型Ⅲ及以上规格仅白名单开放。如需使用，请联系阿里云客户经理。'."\n" + ."\n" + .'实例规格不同，定义也不同。更多信息，请参见[实例规格](~~153127~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值：'."\n" + ."\n" + .'- **false**（默认值）：不开启自动付费，生成订单后需要到<props="china">[订单中心](https://usercenter2.aliyun.com/order/list)</props><props="intl">[订单中心](https://usercenter2-intl.aliyun.com/order/list)</props>完成支付。'."\n" + ."\n" + .'- **true**：开启自动付费，自动支付订单。'."\n" + ."\n" + .'>本参数仅对升配订单生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用优惠券自动支付账单。取值：'."\n" + ."\n" + .'- **true**：使用。'."\n" + .'- **false**（默认值）：不使用。'."\n" + ."\n" + .'>仅**AutoPay**为**true**时，该项才生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '标准型全球加速实例带宽。单位：**Mbps**。'."\n" + ."\n" + .'取值范围：200~5000。'."\n" + .'> 仅实例加速区域接入模式为Anycast时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'IllegalParameter.Spec', + 'errorMessage' => 'The specified Spec is invalid.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAcceleratorResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n</UpdateAcceleratorResponse>","errorExample":""}]', + 'title' => '修改全球加速实例', + 'summary' => '调用UpdateAccelerator接口修改全球加速实例。', + 'description' => '- **UpdateAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但全球加速实例并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示全球加速实例正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示全球加速实例修改完成。'."\n" + .'- **UpdateAccelerator**接口不支持在并发修改同一个全球加速实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAcceleratorConfirm' => [ + 'summary' => '调用UpdateAcceleratorConfirm接口确认修改的全球加速实例规格信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAcceleratorConfirmResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</UpdateAcceleratorConfirmResponse>","errorExample":""}]', + 'title' => '确认修改的全球加速实例规格信息', + 'description' => '修改全球加速实例规格后需要您进行手工确认。**UpdateAcceleratorConfirm**接口用于确认修改的全球加速实例规格信息。调用本接口时，请注意以下事项：'."\n" + .'- **UpdateAcceleratorConfirm**接口属于异步接口，即系统会先返回一个请求ID，但全球加速实例规格信息并未确认完成，系统后台的确认任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示全球加速实例规格修改正在确认中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示全球加速实例规格修改确认完成。'."\n" + .'- **UpdateAcceleratorConfirm**接口不支持并发确认同一个全球加速实例的规格修改。', + ], + 'DeleteAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '7849', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'deprecated' => true, + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'BindExist.Accelerator', + 'errorMessage' => 'The accelerated instance is already bound to a bandwidth package.', + ], + [ + 'errorCode' => 'Exist.IpSet', + 'errorMessage' => 'The IpSet already exists.', + ], + [ + 'errorCode' => 'Exist.Listener', + 'errorMessage' => 'The listener already exists.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\"\\n}","type":"json"}]', + 'title' => '删除全球加速实例', + 'summary' => '调用DeleteAccelerator接口删除指定的全球加速实例。', + 'description' => '- 不支持删除预付费（包年包月）全球加速实例。'."\n" + .'- **DeleteAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但全球加速实例并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**deleting**状态时，表示全球加速实例正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该全球加速实例时，表示全球加速实例删除完成。', + ], + 'AttachDdosToAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7838', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '要绑定DDoS高防实例的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'DdosId', + 'in' => 'query', + 'schema' => [ + 'description' => '要绑定到全球加速实例的DDoS高防实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => true, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + ], + [ + 'name' => 'DdosRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DDoS高防实例所在的地域，取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中国内地。'."\n" + ."\n" + .'- **ap-southeast-1**：非中国内地。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DdosConfigList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例列表。', + 'type' => 'object', + 'properties' => [ + 'DdosRegionId' => [ + 'description' => 'DDoS高防实例所在的地域，取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中国内地。'."\n" + ."\n" + .'- **ap-southeast-1**：非中国内地。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'DdosId' => [ + 'description' => '绑定到全球加速实例的ddos高防实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会进行绑定。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回 HTTP 2xx 状态码。'."\n" + ."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构体。', + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => '绑定到全球加速实例的DDoS高防实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'GaId' => [ + 'description' => '绑定了DDoS高防实例的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DdosId.Error', + 'errorMessage' => 'Failed to find the DDoS instance based on the DDoS ID.', + ], + [ + 'errorCode' => 'NoPermission.GaDdosRoleSession', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DdosId\\": \\"ddoscoo-cn-zz11vq7j****\\",\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"GaId\\": \\"ga-bp1odcab8tmno0hdq****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachDdosToAcceleratorResponse>\\n <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>\\n <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>\\n <GaId>ga-bp1odcab8tmno0hdq****</GaId>\\n</AttachDdosToAcceleratorResponse>","errorExample":""}]', + 'title' => '将DDoS高防实例与全球加速实例绑定', + 'summary' => '如果您想让全球加速的应用不受大规模DDoS攻击的影响，确保服务的稳定性和可用性，您可以调用AttachDdosToAccelerator接口将DDoS高防实例与全球加速实例绑定。', + 'description' => '在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- **AttachDdosToAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但DDoS高防实例与全球加速实例并未绑定完成，系统后台的关联任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)或[ListAccelerators](~~153236~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示DDoS高防实例与全球加速实例正在绑定中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示DDoS高防实例与全球加速实例绑定完成。'."\n" + .'- **AttachDdosToAccelerator**接口不支持并发为同一个全球加速实例绑定DDoS高防实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetachDdosFromAccelerator' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8880', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DdosConfigList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例列表。', + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => '与全球加速实例绑定的DDoS高防实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ddosDip-cn-pj64b8cz101', + ], + 'DdosRegionId' => [ + 'description' => 'DDoS高防实例所在的地域，取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中国内地。'."\n" + ."\n" + .'- **ap-southeast-1**：非中国内地。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会将高防实例解绑。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'DdosId' => [ + 'description' => '与全球加速实例解绑的DDoS高防实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ddoscoo-cn-zz11vq7j****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED28DCAC0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'Accelerator.NotBindingDdos', + 'errorMessage' => 'The accelerator has not bound a DDoS instance.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DdosId\\": \\"ddoscoo-cn-zz11vq7j****\\",\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED28DCAC0\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachDdosFromAcceleratorResponse>\\n <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>\\n <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>\\n</DetachDdosFromAcceleratorResponse>","errorExample":""}]', + 'title' => '将DDoS高防实例与全球加速实例解绑', + 'summary' => '调用DetachDdosFromAccelerator接口将DDoS高防实例与全球加速实例解绑。', + 'description' => '- **DetachDdosFromAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但DDoS高防实例与全球加速实例并未解绑完成，系统后台的解绑任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)或[ListAccelerators](~~153236~~)查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示DDoS高防实例与全球加速实例正在解绑中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态时，表示DDoS高防实例与全球加速实例解绑完成。'."\n" + .'- **DetachDdosFromAccelerator**接口不支持并发解绑同一个全球加速实例的DDoS高防实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSpareIps' => [ + 'summary' => '调用CreateSpareIps接口创建CNAME备用IP，当加速区域异常时，流量可切换到备用IP。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'SpareIps', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'CNAME备用IP列表，当加速区域异常时，流量切换到备用IP。'."\n" + ."\n" + .'您最多可以输入 2 个备用 IP。', + 'type' => 'array', + 'items' => [ + 'description' => 'CNAME备用IP列表，当加速区域异常时，流量切换到备用IP。'."\n" + ."\n" + .'您最多可以输入 2 个备用 IP。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Duplicate.SpareIp', + 'errorMessage' => 'The spare IP address is duplicate.', + ], + [ + 'errorCode' => 'AlreadyExist.SpareIp', + 'errorMessage' => 'The spare ip %s already exists.', + ], + [ + 'errorCode' => 'IllegalParamFormat.SpareIp', + 'errorMessage' => 'The param format of spare ip is illegal.', + ], + [ + 'errorCode' => 'QuotaExceeded.SpareIp', + 'errorMessage' => 'The number of spare ip exceeds the limit.', + ], + [ + 'errorCode' => 'TooManySpareIp.Accelerator', + 'errorMessage' => 'Too many SpareIp accepted under the same Accelerator.', + ], + [ + 'errorCode' => 'NoPermission.CreateSpareIp', + 'errorMessage' => 'You do not have permission to create spareIp.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSpareIpsResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</CreateSpareIpsResponse>","errorExample":""}]', + 'title' => '创建CNAME备用IP', + 'description' => '- **CreateSpareIps**接口属于异步接口，即系统会先返回一个请求ID，但CNAME备用IP并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)查询全球加速实例的状态：'."\n" + ."\n" + .' - 当全球加速实例处于**configuring**状态时，表示全球加速实例的CNAME备用IP正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当全球加速实例处于**active**状态时，表示全球加速实例的CNAME备用IP创建完成。'."\n" + ."\n" + .'- **CreateSpareIps**接口不支持在同一个全球加速实例内并发创建CNAME备用IP。', + ], + 'ListSpareIps' => [ + 'summary' => '调用ListSpareIps接口查询CNAME备用IP列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会查询资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'SpareIps' => [ + 'description' => 'CNAME备用IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'CNAME备用IP列表。', + 'type' => 'object', + 'properties' => [ + 'SpareIp' => [ + 'description' => 'CNAME备用IP，当加速区域异常时，流量切换到该IP。', + 'type' => 'string', + 'example' => '47.100.XX.XX', + ], + 'State' => [ + 'description' => 'CNAME备用IP的状态。取值：'."\n" + .'- **active**：可用。'."\n" + .'- **inuse**：使用中。'."\n", + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"SpareIps\\": [\\n {\\n \\"SpareIp\\": \\"47.100.XX.XX\\",\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSpareIpsResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <SpareIps>\\n <SpareIp>47.100.XX.XX</SpareIp>\\n <State>active</State>\\n </SpareIps>\\n</ListSpareIpsResponse>","errorExample":""}]', + 'title' => '查询CNAME备用IP列表信息', + ], + 'GetSpareIp' => [ + 'summary' => '调用GetSpareIp接口查询CNAME备用IP的状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '33855', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'SpareIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'CNAME备用IP，当加速区域异常时，流量切换到该IP。', + 'type' => 'string', + 'required' => true, + 'example' => '47.100.XX.XX', + 'maxItems' => 2, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'State' => [ + 'description' => 'CNAME备用IP的状态。取值：'."\n" + .'- **active**：可用。'."\n" + .'- **inuse**：使用中。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"State\\": \\"active\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSpareIpResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <State>active</State>\\n</GetSpareIpResponse>","errorExample":""}]', + 'title' => '查询CNAME备用IP的状态', + ], + 'DeleteSpareIps' => [ + 'summary' => '调用DeleteSpareIps接口删除CNAME备用IP。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会删除资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'SpareIps', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'CNAME备用IP列表，当加速区域异常时，流量切换到备用IP。'."\n" + ."\n" + .'您最多可以输入2个备用IP。', + 'type' => 'array', + 'items' => [ + 'description' => 'CNAME备用IP列表，当加速区域异常时，流量切换到备用IP。'."\n" + ."\n" + .'您最多可以输入2个备用IP。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.SpareIp', + 'errorMessage' => 'The spare ip %s doesn\'t exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSpareIpsResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</DeleteSpareIpsResponse>","errorExample":""}]', + 'title' => '删除CNAME备用IP', + 'description' => '- **DeleteSpareIps**接口属于异步接口，即系统会先返回一个请求ID，但CNAME备用IP并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeAccelerator](~~153235~~)接口查询全球加速实例的状态：'."\n" + .' - 当全球加速实例处于**configuring**状态时，表示CNAME备用IP正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当全球加速实例处于**active**状态，且通过[ListSpareIps](~~262121~~)接口已查询不到备用IP地址时，表示CNAME备用IP删除完成。'."\n" + .'- **DeleteSpareIps**接口不支持在同一个全球加速实例内并发删除CNAME备用IP。', + ], + 'DescribeAcceleratorAutoRenewAttribute' => [ + 'summary' => '调用DescribeAcceleratorAutoRenewAttribute接口查询全球加速实例的自动续费状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'AutoRenew' => [ + 'description' => '是否开启了自动续费。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoRenewDuration' => [ + 'description' => '自动续费时长。单位：月。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RenewalStatus' => [ + 'description' => '全球加速实例的自动续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：设置为自动续费。'."\n" + ."\n" + .'- **Normal**：手动续费。'."\n" + ."\n" + .'- **NotRenewal**：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"AutoRenew\\": false,\\n \\"AutoRenewDuration\\": 1,\\n \\"RenewalStatus\\": \\"Normal\\",\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAcceleratorAutoRenewAttributeResponse>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <AutoRenew>false</AutoRenew>\\n <AutoRenewDuration>1</AutoRenewDuration>\\n <RenewalStatus>Normal</RenewalStatus>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n</DescribeAcceleratorAutoRenewAttributeResponse>","errorExample":""}]', + 'title' => '查询全球加速实例的自动续费状态', + ], + 'UpdateAcceleratorAutoRenewAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，ClientToken仅支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）或短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启了自动续费。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> **AutoRenew**和**RenewalStatus**不能同时为空。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RenewalStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例的自动续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：设置为自动续费。'."\n" + ."\n" + .'- **Normal**：手动续费。'."\n" + ."\n" + .'- **NotRenewal**：不再续费，系统不再发送到期提醒，只在到期前第三天发送不续费提醒。不再续费的全球加速实例可以修改成手动续费（**Normal**）后，再自行续费或配置为自动续费（**AutoRenewal**）。'."\n" + ."\n" + .'> - **AutoRenew**和**RenewalStatus**不能同时为空。'."\n" + .'> - 参数**RenewalStatus**的优先级高于参数**AutoRenew**。如果不配置参数**RenewalStatus**，则默认以参数**AutoRenew**为准。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费时长。单位：月。'."\n" + ."\n" + .'取值范围：**1**~**12**。'."\n" + ."\n" + .'> 仅**AutoRenew**的为**true**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAcceleratorAutoRenewAttributeResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n</UpdateAcceleratorAutoRenewAttributeResponse>","errorExample":""}]', + 'title' => '修改全球加速实例的自动续费属性', + 'summary' => '调用UpdateAcceleratorAutoRenewAttribute接口修改全球加速实例的自动续费属性。', + 'description' => '**UpdateAcceleratorAutoRenewAttribute**接口不支持并发修改同一个全球加速实例的自动续费属性。', + ], + 'CreateIpSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1yeeq8yfoyszmqy****', + ], + ], + [ + 'name' => 'AccelerateRegion', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要加速的地域信息。', + 'type' => 'array', + 'items' => [ + 'description' => '要加速的地域信息。', + 'type' => 'object', + 'properties' => [ + 'AccelerateRegionId' => [ + 'description' => '要加速的地域ID。'."\n" + ."\n" + .'可添加地域的数量受带宽总额和全球加速实例规格限制。关于各实例规格支持的接入地域数量，请参见[全球加速实例概述](~~153127~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-huhehaote', + ], + 'IpVersion' => [ + 'description' => '接入全球加速服务的IP地址协议，取值：'."\n" + ."\n" + .'- **IPv4**（默认值）：IPv4地址协议。'."\n" + ."\n" + .'- **IPv6**：IPv6地址协议。'."\n" + ."\n" + .'- **DUAL_STACK**：IPv4和IPv6地址协议。'."\n" + ."\n" + .'> - DUAL_STACK类型仅标准型按量计费的全球加速实例支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv6', + ], + 'Bandwidth' => [ + 'description' => '加速地域分配的带宽，单位为**Mbps**。'."\n" + .'> - 该参数必填。'."\n" + .'> - 每个加速地域支持分配的最小带宽为2Mbps。'."\n" + .'>- 加速地域带宽总额应小于或等于您购买的基础带宽包的带宽。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'IspType' => [ + 'description' => '加速地域公网线路类型。取值：'."\n" + ."\n" + .'- **BGP**：BGP（多线）线路。'."\n" + .'- **BGP\\_PRO**：BGP（多线）_精品线路。'."\n" + ."\n" + .'> - 带宽计费方式为**按流量**的全球加速实例需要配置该项。'."\n" + .'> - 加速地域不同，支持的加速地域公网线路类型不同。', + 'type' => 'string', + 'required' => false, + 'example' => 'BGP', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + 'IpSets' => [ + 'description' => '加速地域配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '加速地域配置信息。', + 'type' => 'object', + 'properties' => [ + 'AccelerateRegionId' => [ + 'description' => '要加速的地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'Bandwidth' => [ + 'description' => '加速地域带宽，单位为**Mbps**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IpSetId' => [ + 'description' => '加速地域ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'IspType' => [ + 'description' => '加速地域公网线路类型。', + 'type' => 'string', + 'example' => 'BGP', + ], + ], + ], + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1yeeq8yfoyszmq****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Domain.NotFit', + 'errorMessage' => 'The domain is not fit the rule', + ], + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'RegionRepeat.IpSet', + 'errorMessage' => 'An accelerator can only have one IpSet in one region. accelerator = %s, region = %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1F4B6A4A-C89E-489E-BAF1-52777EE148EF\\",\\n \\"IpSets\\": [\\n {\\n \\"AccelerateRegionId\\": \\"cn-qingdao\\",\\n \\"Bandwidth\\": 2,\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\",\\n \\"IspType\\": \\"BGP\\"\\n }\\n ],\\n \\"AcceleratorId\\": \\"ga-bp1yeeq8yfoyszmq****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIpSetsResponse>\\n <RequestId>1F4B6A4A-C89E-489E-BAF1-52777EE148EF</RequestId>\\n <IpSets>\\n <AccelerateRegionId>cn-qingdao</AccelerateRegionId>\\n <Bandwidth>2</Bandwidth>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n <IspType>BGP</IspType>\\n </IpSets>\\n <AcceleratorId>ga-bp1yeeq8yfoyszmq****</AcceleratorId>\\n</CreateIpSetsResponse>","errorExample":""}]', + 'title' => '批量创建加速地域', + 'summary' => '调用CreateIpSets接口批量创建加速地域。', + 'description' => '- **CreateIpSets**接口属于异步接口，即系统会先返回一个请求ID，但加速地域并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeIpSet](~~153246~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**init**状态时，表示加速地域正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速地域处于**active**状态时，表示加速地域创建完成。'."\n" + .'- **CreateIpSets**接口不支持在同一个全球加速实例内并发创建加速地域。', + ], + 'DescribeIpSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8877', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '加速地域实例ID。'."\n" + ."\n" + .'您可以通过调用[ListIpSets](~~2253273~~)查询指定全球加速实例下包含的加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11ilwqjdkjeg9r7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpSetId' => [ + 'description' => '加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11ilwqjdkjeg9r7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D2BFF54-6AF2-4679-88C4-2F2E187F16CB', + ], + 'IpVersion' => [ + 'description' => 'IP地址协议版本。取值：'."\n" + ."\n" + .'- **IPv4**'."\n" + .'- **IPv6**'."\n" + .'- **DUAL_STACK**', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'State' => [ + 'description' => '加速地域状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：运行中。'."\n" + ."\n" + .'- **updating**：配置中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'Bandwidth' => [ + 'description' => '加速地域分配的带宽。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'IspType' => [ + 'description' => '加速地域公网线路类型。'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。', + 'type' => 'string', + 'example' => 'BGP', + ], + 'IpAddressList' => [ + 'description' => '加速IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加速IP列表。', + 'type' => 'string', + 'example' => '121.43.XX.XX', + ], + ], + 'AccelerateRegionId' => [ + 'description' => '加速地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1yeeq8yfoyszmqy****', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅当**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'>- 仅当**ServiceManaged**参数为**True**时有效。'."\n" + .'>- 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅当**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行**Action**指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行**Action**指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IpSetId\\": \\"ips-bp11ilwqjdkjeg9r7****\\",\\n \\"RequestId\\": \\"6D2BFF54-6AF2-4679-88C4-2F2E187F16CB\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"State\\": \\"active\\",\\n \\"Bandwidth\\": 3,\\n \\"IspType\\": \\"BGP\\",\\n \\"IpAddressList\\": [\\n \\"121.43.XX.XX\\"\\n ],\\n \\"AccelerateRegionId\\": \\"cn-hangzhou\\",\\n \\"AcceleratorId\\": \\"ga-bp1yeeq8yfoyszmqy****\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeIpSetResponse>\\n <IpSetId>ips-bp11ilwqjdkjeg9r7****</IpSetId>\\n <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>\\n <IpVersion>IPv4</IpVersion>\\n <State>active</State>\\n <Bandwidth>3</Bandwidth>\\n <IspType>BGP</IspType>\\n <IpAddressList>121.43.XX.XX</IpAddressList>\\n <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>\\n <AcceleratorId>ga-bp1yeeq8yfoyszmqy****</AcceleratorId>\\n</DescribeIpSetResponse>","errorExample":""}]', + 'title' => '查询加速地域', + 'summary' => '调用DescribeIpSet接口查询指定加速地域的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListIpSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8889', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**100**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1yeeq8yfoyszmqy****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9B4E54C-9CCD-4002-91A9-D38C6C209192', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IpSets' => [ + 'description' => '加速地域实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加速地域实例列表。', + 'type' => 'object', + 'properties' => [ + 'AccelerateRegionId' => [ + 'description' => '加速地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IpVersion' => [ + 'description' => 'IP地址协议版本。取值：'."\n" + ."\n" + .'- **IPv4**'."\n" + ."\n" + .'- **IPv6**'."\n" + ."\n" + .'- **DUAL_STACK**', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'Bandwidth' => [ + 'description' => '加速地域分配的带宽，单位：**Mbps**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IspType' => [ + 'description' => '加速地域公网线路类型。取值：'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。', + 'type' => 'string', + 'example' => 'BGP', + ], + 'State' => [ + 'description' => '加速地域状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：运行中。'."\n" + ."\n" + .'- **updating**：配置中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'IpSetId' => [ + 'description' => '加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'IpAddressList' => [ + 'description' => '加速IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加速IP列表。', + 'type' => 'string', + 'example' => '121.43..XX.XX', + ], + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + ."\n" + .'> 仅当**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'>- 仅当**ServiceManaged**参数为**True**时有效。'."\n" + .'>- 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅当**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行**Action**指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行**Action**指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A9B4E54C-9CCD-4002-91A9-D38C6C209192\\",\\n \\"PageNumber\\": 1,\\n \\"IpSets\\": [\\n {\\n \\"AccelerateRegionId\\": \\"cn-hangzhou\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"Bandwidth\\": 2,\\n \\"IspType\\": \\"BGP\\",\\n \\"State\\": \\"active\\",\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\",\\n \\"IpAddressList\\": [\\n \\"121.43..XX.XX\\"\\n ],\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListIpSetsResponse>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>A9B4E54C-9CCD-4002-91A9-D38C6C209192</RequestId>\\n <PageNumber>1</PageNumber>\\n <IpSets>\\n <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>\\n <IpVersion>IPv4</IpVersion>\\n <Bandwidth>2</Bandwidth>\\n <State>active</State>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n <IpAddressList>121.43..XX.XX</IpAddressList>\\n </IpSets>\\n</ListIpSetsResponse>","errorExample":""}]', + 'title' => '查询加速地域列表', + 'summary' => '调用ListIpSets接口查询指定全球加速实例的加速地域列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateIpSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8895', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '7D2F7E4E-B958-439C-9821-56D6213A31EC', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的加速地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的加速地域带宽。单位：Mbps。'."\n" + ."\n" + .'每个加速地域支持分配的最小带宽为2Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7D2F7E4E-B958-439C-9821-56D6213A31EC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'StateError.IpSet', + 'errorMessage' => 'The state of IpSet is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'GreaterThanGa.IpSetBandwidth', + 'errorMessage' => 'The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7D2F7E4E-B958-439C-9821-56D6213A31EC\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIpSetResponse>\\n <RequestId>7D2F7E4E-B958-439C-9821-56D6213A31EC</RequestId>\\n</UpdateIpSetResponse>","errorExample":""}]', + 'title' => '修改加速区域中指定的加速地域', + 'summary' => '调用UpdateIpSet接口修改加速区域中指定的加速地域。', + 'description' => '- **UpdateIpSet**接口属于异步接口，即系统会先返回一个请求ID，但加速区域中指定的加速地域并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeIpSet](~~153246~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**updating**状态时，表示加速地域正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速地域处于**active**状态时，表示加速地域修改完成。'."\n" + .'- **UpdateIpSet**接口不支持在同一个全球加速实例内并发修改加速地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateIpSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8896', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpSets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '加速地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加速地域列表。'."\n" + .'您最多可输入100个加速地域信息。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'description' => '要修改的加速地域带宽。单位：Mbps。'."\n" + ."\n" + .'每个加速地域支持分配的最小带宽为2 Mbps。'."\n" + .'您最多可输入100个加速地域带宽。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + 'IpSetId' => [ + 'description' => '要修改的加速地域ID。'."\n" + ."\n" + .'您最多可输入100个加速地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11c9mpphtb1xkds****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '685662FF-B1CE-4D5C-A4C8-2FF3C2146BFC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Repeat.IpSets', + 'errorMessage' => 'The configuration of IpSet is duplicated.', + ], + [ + 'errorCode' => 'NotExist.IpSets', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'NotActive.IpSet', + 'errorMessage' => 'The state of IpSet is not active.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'GreaterThanGa.IpSetBandwidth', + 'errorMessage' => 'The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"685662FF-B1CE-4D5C-A4C8-2FF3C2146BFC\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIpSetsResponse>\\n <RequestId>685662FF-B1CE-4D5C-A4C8-2FF3C2146BFC</RequestId>\\n</UpdateIpSetsResponse>","errorExample":""}]', + 'title' => '修改加速区域中的多个加速地域', + 'summary' => '调用UpdateIpSets接口修改加速区域中的多个加速地域。', + 'description' => '- **UpdateIpSets**接口属于异步接口，即系统会先返回一个请求ID，但加速地域并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeIpSet](~~153246~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**updating**状态时，表示加速地域正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速地域处于**active**状态时，表示加速地域修改完成。'."\n" + .'- **UpdateIpSets**接口不支持在同一个全球加速实例内并发修改加速地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteIpSet' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7852', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => 'DD61839A-5CC5-404B-8C6E-56066F0C432D', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1yeeq8yfoyszmqy****', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的加速地域实例ID。'."\n" + ."\n" + .'您可以通过调用[ListIpSets](~~2253273~~)查询指定全球加速实例下包含的加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DD61839A-5CC5-404B-8C6E-56066F0C432D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'StateError.IpSet', + 'errorMessage' => 'The state of IpSet is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'ExplicitDeny', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD61839A-5CC5-404B-8C6E-56066F0C432D\\"\\n}","type":"json"}]', + 'title' => '删除一个加速地域', + 'summary' => '调用DeleteIpSet接口删除一个加速地域。', + 'description' => '- **DeleteIpSet**接口属于异步接口，即系统会先返回一个请求ID，但加速地域并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeIpSet](~~153246~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**deleting**状态时，表示加速地域正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该加速地域时，表示加速地域删除完成。'."\n" + .'- **DeleteIpSet**接口不支持在同一个全球加速实例内并发删除加速地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteIpSets' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7853', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpSetIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的加速地域的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的加速地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'required' => true, + 'example' => 'ips-bp11c9mpphtb1xkds****', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B49B60F6-F6C8-49E5-B06B-E33E3A469A92', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.IpSets', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'NotActive.IpSet', + 'errorMessage' => 'The state of IpSet is not active.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B49B60F6-F6C8-49E5-B06B-E33E3A469A92\\"\\n}","type":"json"}]', + 'title' => '删除多个加速地域', + 'summary' => '调用DeleteIpSets接口删除多个加速地域。', + 'description' => '- **DeleteIpSets**接口属于异步接口，即系统会先返回一个请求ID，但加速地域并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeIpSet](~~153246~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**deleting**状态时，表示加速地域正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到要删除的加速地域时，表示加速地域删除完成。'."\n" + .'- **DeleteIpSets**接口不支持在同一个全球加速实例内并发删除加速地域。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAvailableAccelerateAreas' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8883', + 'abilityTreeNodes' => [ + 'FEATUREgaC1Y0Y9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1yeeq8yfoyszmqy****', + ], + ], + [ + 'name' => 'AccessMode', + 'in' => 'query', + 'schema' => [ + 'title' => '加速地域接入类型，取值如下：'."\n" + .'anycast：查询支持的anycast加速地域，空值：查询支持的非anycast加速地域', + 'description' => '加速区域接入模式，取值如下：'."\n" + ."\n" + .'- anycast：查询支持的anycast加速地域'."\n" + .'- 其它值：查询支持的非anycast加速地域', + 'type' => 'string', + 'required' => false, + 'example' => 'anycast', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9B4E54C-9CCD-4002-91A9-D38C6C209192', + ], + 'Areas' => [ + 'description' => '区域信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '区域信息列表。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '区域名称。', + 'type' => 'string', + 'example' => 'China North', + ], + 'AreaId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-huabei', + ], + 'RegionList' => [ + 'description' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域列表信息。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => 'China (Qingdao)', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'IspTypeList' => [ + 'description' => '加速地域公网线路类型。'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。', + 'type' => 'array', + 'items' => [ + 'description' => '加速地域公网线路类型。'."\n" + .'- **BGP**（默认值）：BGP（多线）线路。'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路。', + 'type' => 'string', + 'example' => 'BGP', + ], + ], + 'ChinaMainland' => [ + 'description' => '是否为中国大陆。取值：'."\n" + ."\n" + .'- **true**：是中国大陆。'."\n" + ."\n" + .'- **false**：不是中国大陆。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportIpv6' => [ + 'description' => '是否支持IPv6，取值：'."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MultiAz' => [ + 'description' => '是否支持多可用区，取值：'."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9B4E54C-9CCD-4002-91A9-D38C6C209192\\",\\n \\"Areas\\": [\\n {\\n \\"LocalName\\": \\"China North\\",\\n \\"AreaId\\": \\"cn-huabei\\",\\n \\"RegionList\\": [\\n {\\n \\"LocalName\\": \\"China (Qingdao)\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"IspTypeList\\": [\\n \\"BGP\\"\\n ],\\n \\"ChinaMainland\\": true,\\n \\"SupportIpv6\\": true,\\n \\"MultiAz\\": true\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAvailableAccelerateAreasResponse>\\n <RequestId>A9B4E54C-9CCD-4002-91A9-D38C6C209192</RequestId>\\n <Areas>\\n <LocalName>华北</LocalName>\\n <AreaId>cn-huabei</AreaId>\\n <RegionList>\\n <LocalName>青岛</LocalName>\\n <RegionId>cn-qingdao</RegionId>\\n </RegionList>\\n </Areas>\\n</ListAvailableAccelerateAreasResponse>","errorExample":""}]', + 'title' => '列出可用加速区域', + 'summary' => '调用ListAvailableAccelerateAreas接口查询可用的加速地域。', + ], + 'GetIpsetsBandwidthLimit' => [ + 'summary' => '调用GetIpsetsBandwidthLimit接口获取加速区域带宽阈值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询加速区域带宽分配限制信息的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'BandwidthLimit' => [ + 'description' => '加速区域的带宽峰值限额。单位为Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'BandwidthAllocationType' => [ + 'description' => '带宽分配类型。'."\n" + ."\n" + .'- **ShareBandwidth**：共享带宽。'."\n" + ."\n" + .'- **ExclusiveBandwidth**：独享带宽。', + 'type' => 'string', + 'example' => 'ShareBandwidth', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"BandwidthLimit\\": 20,\\n \\"BandwidthAllocationType\\": \\"ShareBandwidth\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<GetIpsetsBandwidthLimitResponse>\\n <BandwidthLimit>20</BandwidthLimit>\\n <BandwidthAllocationType>ShareBandwidth</BandwidthAllocationType>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</GetIpsetsBandwidthLimitResponse>","errorExample":""}]', + 'title' => '查询加速地域带宽阈值', + 'description' => '本接口用于查询带宽计费方式为**按带宽**的标准型全球加速实例各加速地域的带宽峰值限额，即全球加速实例所绑定基础带宽包的带宽值。', + ], + 'CreateListener' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7848', + 'abilityTreeNodes' => [ + 'FEATUREgaZW5ZHQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000 ', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Listener', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的描述信息。'."\n" + ."\n" + .'描述长度最大为200个字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'Listener', + ], + ], + [ + 'name' => 'ClientAffinity', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端亲和性。'."\n" + ."\n" + .'- 不传入值时，不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。'."\n" + ."\n" + .'- 取值为**SOURCE_IP**时，保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'SOURCE_IP', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的网络传输协议类型，取值：'."\n" + ."\n" + .'- **tcp**：TCP协议。'."\n" + ."\n" + .'- **udp**：UDP协议。'."\n" + ."\n" + .'- **http**：HTTP协议。'."\n" + ."\n" + .'- **https**：HTTPS协议。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'PortRanges', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监听端口信息。'."\n" + .'可配置的监听端口范围为**1**~**65499**。'."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '监听端口信息。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的起始监听端口。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**，且需满足**FromPort**≤**ToPort**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。'."\n" + .'>对于HTTP或HTTPS协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'ToPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的结束监听端口。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**，且需满足**FromPort**≤**ToPort**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。'."\n" + ."\n" + .'>对于HTTP或HTTPS协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Certificates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'SSL证书列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SSL证书列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'SSL证书ID。'."\n" + ."\n" + .'>仅HTTPS协议的监听需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '449****-cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'XForwardedForConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '`XForward`字段配置信息。', + 'type' => 'object', + 'properties' => [ + 'XForwardedForGaIdEnabled' => [ + 'description' => '是否通过`GA-ID`头字段获取全球加速实例ID。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForGaApEnabled' => [ + 'description' => '是否通过`GA-AP`字段获取加速地域信息。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForProtoEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Proto`字段获取全球加速实例的监听协议。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForPortEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Port`字段获取全球加速实例的监听端口。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XRealIpEnabled' => [ + 'description' => '是否通过`X-Real-IP`字段获取真实的客户端IP。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SecurityPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全策略实例ID。取值：'."\n" + ."\n" + .'- **tls_cipher_policy_1_0**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.0、TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_1**'."\n" + ."\n" + .' - 支持的TLS版本： TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA和ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict_with_1_3**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2及TLSv1.3。'."\n" + ."\n" + .' - 支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'tls_cipher_policy_1_0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的路由类型。取值：'."\n" + ."\n" + .'- **Standard**（默认值）：智能路由类型。'."\n" + .'- **CustomRouting**：自定义路由类型。'."\n" + ."\n" + .'> - 监听支持自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。'."\n" + .'> - 同一个标准型全球加速实例，不支持同时配置两种路由类型的监听，且路由类型配置完成后不支持变更。更多信息，请参见[监听概述](~~153216~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'EndpointGroupConfigurations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '智能路由类型监听的终端节点组的配置信息。'."\n" + ."\n" + .'您最多可以配置10个该类型终端节点组。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '智能路由类型监听的终端节点组配置。'."\n" + ."\n" + .'您最多可以配置10个该类型终端节点组。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupName' => [ + 'description' => '智能路由类型监听的终端节点组名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。'."\n" + ."\n" + .'您最多可以输入10个终端节点组名称。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'EndpointGroupDescription' => [ + 'description' => '智能路由类型监听的终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能包含`http://`和`https://`字符。'."\n" + ."\n" + .'您最多可以输入10个终端节点组描述信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'EndpointGroupRegion' => [ + 'description' => '智能路由类型监听的终端节点组所属地域ID。'."\n" + ."\n" + .'您最多可以输入10个终端节点组的地域ID。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'TrafficPercentage' => [ + 'description' => '流量调配值，即智能路由类型监听有多个终端节点组时，配置到不同终端节点组的流量比例。'."\n" + ."\n" + .'取值范围：**1**~**100**。默认值：**100**。'."\n" + ."\n" + .'您最多可以输入10个终端节点组的流量调配值。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'HealthCheckEnabled' => [ + 'description' => '是否为智能路由类型监听的终端节点组开启健康检查。取值：'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**（默认值）：关闭健康检查。'."\n" + ."\n" + .'您最多可以开启10个终端节点组的健康检查。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HealthCheckIntervalSeconds' => [ + 'description' => '健康检查的时间间隔，单位：秒。'."\n" + ."\n" + .'您最多可以输入10个健康检查的时间间隔。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'HealthCheckPath' => [ + 'description' => '健康检查路径。'."\n" + ."\n" + .'您最多可以输入10个健康检查路径。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => '/healthcheck', + ], + 'HealthCheckPort' => [ + 'description' => '健康检查的端口。取值范围：**1**~**65535**。'."\n" + ."\n" + .'您最多可以输入10个健康检查的端口。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'HealthCheckProtocol' => [ + 'description' => '健康检查的协议。取值：'."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + .'- **https**或**HTTPS**：HTTPS协议。'."\n" + ."\n" + .'您最多可以输入10个健康检查的协议。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + 'ThresholdCount' => [ + 'description' => '针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。'."\n" + .'取值范围：**2**~**10**。默认值：**3**。'."\n" + ."\n" + .'您最多可以输入10个健康检查状态变化所需要的连续健康检查次数值。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'EndpointConfigurations' => [ + 'description' => '智能路由类型监听的终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '智能路由类型监听的终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '智能路由类型监听的终端节点类型。取值：'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB 实例。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入100个终端节点类型。'."\n" + .'>- 当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息，且该参数必填。'."\n" + .'>- 终端节点类型取值为**ECS**、**ENI**、**SLB**、**ALB**、**NLB**或**IpTarget**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。'."\n" + .'>- 终端节点类型取值为**ALB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。'."\n" + .'>- 终端节点类型取值为**OSS**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。'."\n" + .'>- 终端节点类型取值为**NLB**时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaNlb的服务关联角色。'."\n" + .'>> 更多信息，请参见[服务关联角色](~~178360~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Ip', + ], + 'Weight' => [ + 'description' => '智能路由类型监听的终端节点权重。'."\n" + ."\n" + .'取值范围：**0**~**255**。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入100个终端节点的权重。'."\n" + ."\n" + .'> - 当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息，且该参数必填。'."\n" + .'> - 如果某个终端节点的权重设置为0，全球加速将终止向该终端节点分发流量，请您谨慎操作。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'Endpoint' => [ + 'description' => '智能路由类型监听的终端节点的IP或域名。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入100个终端节点的IP或域名。'."\n" + ."\n" + .'> 当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息，且该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '47.0.XX.XX', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n" + ."\n" + .'> 当终端节点类型为**ENI**时，可以选择配置该参数，如果不配置默认为ENI的主私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.XX.XX', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否使用自动获取方式开启保持客户端源 IP 功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n\n" + .'>- UDP/TCP 监听对应的终端节点组默认不开启保持客户端源IP，您可根据业务需要配置。'."\n" + .'>- HTTP（S）监听对应的终端节点组默认开启保持客户端源IP，通过X-Forwarded-For头字段获取。不支持关闭。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + .'>- 仅支持TCP监听对应的终端节点组配置。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入1个专有网络ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp13r1kpr2lel****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入2个虚拟交换机ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。'."\n" + .'> - 该虚拟交换机属于**VpcId**参数指定的专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-0jlhcznhw5m7pz2fa****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'EndpointRequestProtocol' => [ + 'description' => '智能路由类型监听的终端节点后端服务协议。取值：'."\n" + .'- **HTTP**（默认值）：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。'."\n" + ."\n" + .'您最多可以输入10个后端服务协议。'."\n" + .'>- 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。'."\n" + .'>- 仅为HTTP或HTTPS协议的智能路由类型监听创建终端节点组时才支持配置该项。'."\n" + .'>- 对于HTTP协议的监听，后端服务协议支持且仅支持**HTTP**。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'EndpointProtocolVersion' => [ + 'description' => '智能路由类型监听的终端节点后端服务协议版本。取值：'."\n" + ."\n" + .'- **HTTP1.1**（默认值）：HTTP1.1版本。'."\n" + ."\n" + .'- **HTTP2**：HTTP2版本。'."\n" + ."\n" + .'> 仅当EndpointRequestProtocol（终端节点后端服务协议）值为HTTPS时，支持配置终端节点后端服务协议版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP1.1', + ], + 'EndpointGroupType' => [ + 'description' => '智能路由类型监听的终端节点组类型。取值：'."\n" + .'- **default**（默认值）：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。'."\n" + ."\n" + .'您最多可以输入10个终端节点组类型。'."\n" + ."\n" + .'>- 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。'."\n" + .'>- 仅HTTP或HTTPS协议的智能路由类型监听才支持创建虚拟终端节点组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'PortOverrides' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '配置端口映射时的监听端口。'."\n" + ."\n" + .'您最多可以输入5个端口映射中的监听端口。'."\n" + ."\n" + .'>- 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。'."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '配置端口映射时的终端节点端口。'."\n" + ."\n" + .'您最多可以输入5个端口映射中的终端节点端口。'."\n" + ."\n" + .'>- 仅当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息。'."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'HealthCheckHost' => [ + 'description' => '健康检查域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.taobao.com', + ], + 'EndpointIpVersion' => [ + 'description' => '后端IP地址协议。取值： '."\n" + .'- **IPv4**：（默认值）：GA仅使用IPv4地址与终端节点服务通信。 '."\n" + .'- **IPv6**：GA仅使用IPv6地址与终端节点服务通信。 '."\n" + .'- **ProtocolAffinity**：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'CustomRoutingEndpointGroupConfigurations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '自定义路由类型监听的终端节点组配置信息。'."\n" + ."\n" + .'您最多可以配置5个该类型终端节点组。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义路由类型监听的终端节点组配置信息。'."\n" + ."\n" + .'您最多可以配置5个该类型终端节点组。'."\n" + ."\n\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupRegion' => [ + 'description' => '自定义路由类型监听的终端节点组所属地域ID。'."\n" + ."\n" + .'您最多可以输入5个终端节点组地域ID。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Name' => [ + 'description' => '自定义路由类型监听的终端节点组名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。'."\n" + ."\n" + .'最多可以输入5个终端节点组名称。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Description' => [ + 'description' => '自定义路由类型监听的终端节点组的描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能包含`http://`和`https://`字符。'."\n" + ."\n" + .'最多可以输入5个终端节点组的描述信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'DestinationConfigurations' => [ + 'description' => '自定义路由类型监听的终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入20条映射端口范围和协议类型信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '自定义路由类型监听的终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入20条映射端口范围和协议类型信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'Protocols' => [ + 'description' => '自定义路由类型监听的终端节点组后端服务的协议类型。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义路由类型监听的终端节点组后端服务协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'required' => false, + ], + 'FromPort' => [ + 'description' => '自定义路由类型监听的终端节点组后端服务起始端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入20条后端服务起始端口信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '自定义路由类型监听的终端节点组后端服务结束端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入20条后端服务结束端口信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'EndpointConfigurations' => [ + 'description' => '自定义路由类型监听的终端节点信息。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入10个终端节点信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义路由类型监听的终端节点信息。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点组下，最多可输入10个终端节点信息。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '自定义路由类型监听的终端节点后端服务类型。取值：'."\n" + ."\n" + .' **PrivateSubNet**（默认值）：私网CIDR。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateSubNet', + ], + 'Endpoint' => [ + 'description' => '自定义路由类型监听的终端节点交换机（vSwitch）实例名称。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-test01', + ], + 'TrafficToEndpointPolicy' => [ + 'description' => '自定义路由类型监听的终端节点后端服务流量通行策略，取值：'."\n" + .'- **DenyAll**（默认值）：拒绝所有访问流量访问指定后端服务。'."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。'."\n" + .'您需要指定该通信目标的IP地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'DenyAll', + ], + 'PolicyConfigurations' => [ + 'description' => '自定义路由类型监听的终端节点流量通行目标配置。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义路由类型监听的终端节点流量通行目标配置。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标IP地址。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（流量通行策略）取值为**AllowCustom**（指定可接受访问流量的通行目标）时，该项生效。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个端口范围。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（流量通行策略）取值为**AllowCustom**（指定可接受访问流量的通行目标）时，该项生效。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个端口范围。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（流量通行策略）取值为**AllowCustom**（指定可接受访问流量的通行目标）时，该项生效。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个起始端口。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（流量通行策略）取值为**AllowCustom**（指定可接受访问流量的通行目标）时，该项生效。'."\n" + ."\n" + .'自定义路由类型监听的每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个结束端口。'."\n" + ."\n" + .'> 仅当**Type**（监听路由类型）值为**CustomRouting**（自定义路由类型）时，支持配置自定义路由类型监听的终端节点组和终端节点信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IdleTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '连接空闲超时时间。单位：秒。'."\n" + ."\n" + .'- TCP：10-900s，默认900s'."\n" + .'- UDP：10-20s ，默认20s '."\n" + .'- HTTP/HTTPS：1-60秒，默认15s ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '900', + ], + ], + [ + 'name' => 'RequestTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP/HTTPS的连接请求超时时间。单位：秒。'."\n" + ."\n" + .'可选：1-180秒，默认60s。'."\n" + ."\n" + .'>仅对Protocol（网络传输协议类型）为HTTP或HTTPS的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回HTTP 504错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'HttpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP协议的最大版本，取值：'."\n" + .'- **http3**：HTTP/3。'."\n" + .'- **http2**（默认值）：HTTP/2。'."\n" + .'- **http1.1**：HTTP/1.1。'."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'http2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'ProtocalIllegal.Listener', + 'errorMessage' => 'The specified listener protocol is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Listener', + 'errorMessage' => 'The maximum number of listeners is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.ListenerPort', + 'errorMessage' => 'The maximum number of listener ports is exceeded.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'listener port %s is not exist', + ], + [ + 'errorCode' => 'PortRangeIllegal.Listener', + 'errorMessage' => 'The specified listener port range is invalid.', + ], + [ + 'errorCode' => 'PortRangeIllegal.Count', + 'errorMessage' => 'The hugePort listener only supports one port range.', + ], + [ + 'errorCode' => 'PortConflict.Listener', + 'errorMessage' => 'The listener port configuration is in conflict.', + ], + [ + 'errorCode' => 'PortRangeIllegal.ExceedGaAbility', + 'errorMessage' => 'The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).', + ], + [ + 'errorCode' => 'PortRangeIllegal.UDP', + 'errorMessage' => 'UDP ports 250, 4789, and 4790 are system reserved ports.', + ], + [ + 'errorCode' => 'SystemPort.Listener', + 'errorMessage' => 'Ports 65500-65535 are system reserved ports.', + ], + [ + 'errorCode' => 'PortRanges.MustOne', + 'errorMessage' => 'The portRanges must be one for HTTPS and HTTP type listener.', + ], + [ + 'errorCode' => 'SecurityPolicyId.NotNeed', + 'errorMessage' => 'No security policy ID is required for the listener.', + ], + [ + 'errorCode' => 'SecurityPolicyIdIllegal.Listener', + 'errorMessage' => 'The listener security policy ID %s is illegal.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateListenerResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n</CreateListenerResponse>","errorExample":""}]', + 'title' => '创建监听', + 'summary' => '创建监听全球加速实例。', + 'description' => '在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- **CreateListener**接口属于异步接口，即系统会先返回一个监听ID，但监听并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**init**状态时，表示监听正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示监听创建完成。'."\n" + .'- **CreateListener**接口不支持在同一个全球加速实例内并发创建监听。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeListener' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8878', + 'abilityTreeNodes' => [ + 'FEATUREgaZW5ZHQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的监听的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '监听的描述信息。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + 'State' => [ + 'description' => '监听的状态。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'description' => '创建监听的时间戳。单位：毫秒。', + 'type' => 'string', + 'example' => '1577786252000', + ], + 'PortRanges' => [ + 'description' => '监听端口信息。', + 'type' => 'array', + 'items' => [ + 'description' => '监听端口信息。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的起始监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ToPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的结束监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + 'BackendPorts' => [ + 'description' => '后端端口信息。', + 'type' => 'array', + 'items' => [ + 'description' => '后端端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '后端服务器接收请求的起始端口。'."\n" + ."\n" + .'当您的监听协议为HTTPS，且监听的端口和后端服务器提供服务的端口一致时才会返回该项。', + 'type' => 'string', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '后端服务器接收请求的结束端口。', + 'type' => 'string', + 'example' => '80', + ], + ], + ], + ], + 'Certificates' => [ + 'description' => 'SSL证书列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SSL证书列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'目前，仅支持返回**Server**（服务端证书）。', + 'type' => 'string', + 'example' => 'Server', + ], + 'Id' => [ + 'description' => 'SSL证书ID。'."\n", + 'type' => 'string', + 'example' => '449****-cn-hangzhou', + ], + ], + ], + ], + 'Protocol' => [ + 'description' => '监听的网络传输协议类型。'."\n" + .'- **TCP**：TCP协议。'."\n" + .'- **UDP**：UDP协议。'."\n" + .'- **HTTP**：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'ClientAffinity' => [ + 'description' => '客户端亲和性。'."\n" + ."\n" + .'- 返回为**NONE**时：不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。'."\n" + ."\n" + .'- 返回为**SOURCE_IP**时，保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。', + 'type' => 'string', + 'example' => 'SOURCE_IP', + ], + 'Name' => [ + 'description' => '监听的名称。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'RelatedAcls' => [ + 'description' => '监听绑定的访问控制策略组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '监听绑定的访问控制策略组信息。', + 'type' => 'object', + 'properties' => [ + 'AclId' => [ + 'description' => '监听绑定的访问策略组ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Status' => [ + 'description' => '是否开启了访问控制功能。'."\n" + ."\n" + .'- **Associated**：已开启。', + 'type' => 'string', + 'example' => 'Associated', + ], + ], + ], + ], + 'AclType' => [ + 'description' => '访问控制类型：'."\n" + .'- **white**：仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求，白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的IP可以访问全球加速监听。如果开启了白名单访问，但访问策略组中没有添加任何IP，则全球加速监听不会转发请求。'."\n" + .'- **black**：来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发，黑名单适用于应用只限制某些特定IP访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何IP，则全球加速监听会转发全部请求。'."\n" + ."\n" + .'当**Status**参数的值为**on**时，返回该项。', + 'type' => 'string', + 'example' => 'white', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ProxyProtocol' => [ + 'description' => '是否开启了保持客户端源IP功能。'."\n" + .'- **true**：开启了保持客户端源IP功能。开启后，支持后端服务查看客户端的原始IP地址。'."\n" + .'- **false**：未开启保持客户端源IP功能。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'XForwardedForConfig' => [ + 'description' => '`XForward`字段配置信息。', + 'type' => 'object', + 'properties' => [ + 'XForwardedForGaIdEnabled' => [ + 'description' => '是否通过`GA-ID`头字段获取全球加速实例ID。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForGaApEnabled' => [ + 'description' => '是否通过`GA-AP`字段获取加速地域信息。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForProtoEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Proto`字段获取全球加速实例的监听协议。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForPortEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Port`字段获取全球加速实例的监听端口。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XRealIpEnabled' => [ + 'description' => '是否通过`X-Real-IP`字段获取真实的客户端IP。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'SecurityPolicyId' => [ + 'description' => '安全策略实例ID。'."\n" + ."\n" + .'- **tls_cipher_policy_1_0**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.0、TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_1**'."\n" + ."\n" + .' - 支持的TLS版本： TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA和ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict_with_1_3**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2及TLSv1.3。'."\n" + ."\n" + .' - 支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'example' => 'tls_cipher_policy_1_0', + ], + 'Type' => [ + 'description' => '监听的路由类型。'."\n" + ."\n" + .'- **Standard**：智能路由类型。'."\n" + ."\n" + .'- **CustomRouting**：自定义路由类型。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'IdleTimeout' => [ + 'description' => '连接空闲超时时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'RequestTimeout' => [ + 'description' => 'HTTP/HTTPS的连接请求超时时间。单位：秒。'."\n" + .'>仅对Protocol（网络传输协议类型）为HTTP或HTTPS的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回HTTP 504错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'HttpVersion' => [ + 'description' => 'HTTP协议的最大版本，取值：'."\n" + .'- **http3**：HTTP/3。'."\n" + .'- **http2**：HTTP/2。'."\n" + .'- **http1.1**：HTTP/1.1。'."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'example' => 'http2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"Listener\\",\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\",\\n \\"State\\": \\"active\\",\\n \\"CreateTime\\": \\"1577786252000\\",\\n \\"PortRanges\\": [\\n {\\n \\"FromPort\\": 20,\\n \\"ToPort\\": 20\\n }\\n ],\\n \\"BackendPorts\\": [\\n {\\n \\"FromPort\\": \\"80\\",\\n \\"ToPort\\": \\"80\\"\\n }\\n ],\\n \\"Certificates\\": [\\n {\\n \\"Type\\": \\"Server\\",\\n \\"Id\\": \\"449****-cn-hangzhou\\"\\n }\\n ],\\n \\"Protocol\\": \\"TCP\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"ClientAffinity\\": \\"SOURCE_IP\\",\\n \\"Name\\": \\"Listener\\",\\n \\"RelatedAcls\\": [\\n {\\n \\"AclId\\": \\"123\\",\\n \\"Status\\": \\"Associated\\"\\n }\\n ],\\n \\"AclType\\": \\"white\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ProxyProtocol\\": false,\\n \\"XForwardedForConfig\\": {\\n \\"XForwardedForGaIdEnabled\\": false,\\n \\"XForwardedForGaApEnabled\\": false,\\n \\"XForwardedForProtoEnabled\\": false,\\n \\"XForwardedForPortEnabled\\": false,\\n \\"XRealIpEnabled\\": false\\n },\\n \\"SecurityPolicyId\\": \\"tls_cipher_policy_1_0\\",\\n \\"Type\\": \\"Standard\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"IdleTimeout\\": 900,\\n \\"RequestTimeout\\": 60,\\n \\"HttpVersion\\": \\"http2\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeListenerResponse>\\n <Description>Listener</Description>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n <State>active</State>\\n <CreateTime>1577786252000</CreateTime>\\n <PortRanges>\\n <FromPort>20</FromPort>\\n <ToPort>20</ToPort>\\n </PortRanges>\\n <BackendPorts>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n </BackendPorts>\\n <Certificates>\\n <Type>Server</Type>\\n <Id>449****-cn-hangzhou</Id>\\n </Certificates>\\n <Protocol>TCP</Protocol>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <ClientAffinity>SOURCE_IP</ClientAffinity>\\n <Name>Listener</Name>\\n <RelatedAcls>\\n <AclId>123</AclId>\\n <Status>off</Status>\\n </RelatedAcls>\\n <AclType>white</AclType>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ProxyProtocol>false</ProxyProtocol>\\n <XForwardedForConfig>\\n <XForwardedForGaIdEnabled>false</XForwardedForGaIdEnabled>\\n <XForwardedForGaApEnabled>false</XForwardedForGaApEnabled>\\n <XForwardedForProtoEnabled>false</XForwardedForProtoEnabled>\\n <XForwardedForPortEnabled>false</XForwardedForPortEnabled>\\n <XRealIpEnabled>false</XRealIpEnabled>\\n </XForwardedForConfig>\\n <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>\\n <Type>Standard</Type>\\n</DescribeListenerResponse>","errorExample":""}]', + 'title' => '查询监听', + 'summary' => '调用DescribeListener接口查询指定监听的配置信息。', + 'description' => '本接口用于查询指定监听的配置信息，包括监听的路由类型、状态、创建的时间戳、端口信息等。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListListeners' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8890', + 'abilityTreeNodes' => [ + 'FEATUREgaZW5ZHQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数，最大值为**50**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '监听网络的传输协议类型', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Listeners' => [ + 'description' => '监听信息。', + 'type' => 'array', + 'items' => [ + 'description' => '监听信息。', + 'type' => 'object', + 'properties' => [ + 'Certificates' => [ + 'description' => 'SSL证书信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'SSL证书信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '证书类型。'."\n" + ."\n" + .'目前，仅支持返回**Server**（服务端证书）。', + 'type' => 'string', + 'example' => 'Server', + ], + 'Id' => [ + 'description' => 'SSL证书ID。', + 'type' => 'string', + 'example' => '44983xxxx-cn-hangzhou', + ], + ], + ], + ], + 'BackendPorts' => [ + 'description' => '后端服务器端口信息。', + 'type' => 'array', + 'items' => [ + 'description' => '后端服务器端口信息。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '后端服务器的起始端口。', + 'type' => 'string', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '后端服务器的结束端口。', + 'type' => 'string', + 'example' => '80', + ], + ], + ], + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'Description' => [ + 'description' => '监听的描述信息。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'State' => [ + 'description' => '监听的状态。'."\n" + ."\n" + .'- **active**：正常。 '."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **updating**：配置中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'ClientAffinity' => [ + 'description' => '客户端亲和性。'."\n" + ."\n" + .'- 返回为**NONE**时：不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。'."\n" + ."\n" + .'- 返回为**SOURCE_IP**时，保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。', + 'type' => 'string', + 'example' => 'SOURCE_IP', + ], + 'Protocol' => [ + 'description' => '监听的网络传输协议类型。'."\n" + .'- **TCP**：TCP协议。'."\n" + .'- **UDP**：UDP协议。'."\n" + .'- **HTTP**：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'CreateTime' => [ + 'description' => '创建监听的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577786252000', + ], + 'PortRanges' => [ + 'description' => '监听端口信息。', + 'type' => 'array', + 'items' => [ + 'description' => '监听端口信息。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的起始监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ToPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的结束监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + 'Name' => [ + 'description' => '监听的名称。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'ProxyProtocol' => [ + 'description' => '是否开启了保持客户端源IP功能。'."\n" + ."\n" + .'- **true**：开启了保持客户端源IP功能。开启后，支持后端服务查看客户端的原始IP地址。'."\n" + ."\n" + .'- **false**：未开启保持客户端源IP功能。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'true', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'XForwardedForConfig' => [ + 'description' => '`XForward`字段配置信息。', + 'type' => 'object', + 'properties' => [ + 'XForwardedForGaIdEnabled' => [ + 'description' => '是否通过`GA-ID`头字段获取全球加速实例ID。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XRealIpEnabled' => [ + 'description' => '是否通过`X-Real-IP`字段获取真实的客户端IP。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForGaApEnabled' => [ + 'description' => '是否通过`GA-AP`字段获取加速地域信息。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForProtoEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Proto`字段获取全球加速实例的监听协议。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'XForwardedForPortEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Port`字段获取全球加速实例的监听端口。'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'SecurityPolicyId' => [ + 'description' => '安全策略实例ID。'."\n" + ."\n" + .'- **tls_cipher_policy_1_0**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.0、TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_1**'."\n" + ."\n" + .' - 支持的TLS版本： TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA和ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict_with_1_3**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2及TLSv1.3。'."\n" + ."\n" + .' - 支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'example' => 'tls_cipher_policy_1_0', + ], + 'Type' => [ + 'description' => '监听的路由类型。'."\n" + ."\n" + .'- **Standard**：智能路由类型。'."\n" + ."\n" + .'- **CustomRouting**：自定义路由类型。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'IdleTimeout' => [ + 'description' => '连接空闲超时时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'RequestTimeout' => [ + 'description' => 'HTTP/HTTPS的连接请求超时时间。单位：秒。'."\n" + .'>仅对Protocol（网络传输协议类型）为HTTP或HTTPS的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回HTTP 504错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'HttpVersion' => [ + 'description' => 'HTTP协议的最大版本，取值：'."\n" + .'- **http3**：HTTP/3。'."\n" + .'- **http2**：HTTP/2。'."\n" + .'- **http1.1**：HTTP/1.1。'."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'example' => 'http2', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"Listeners\\": [\\n {\\n \\"Certificates\\": [\\n {\\n \\"Type\\": \\"Server\\",\\n \\"Id\\": \\"44983xxxx-cn-hangzhou\\"\\n }\\n ],\\n \\"BackendPorts\\": [\\n {\\n \\"FromPort\\": \\"80\\",\\n \\"ToPort\\": \\"80\\"\\n }\\n ],\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"Description\\": \\"Listener\\",\\n \\"State\\": \\"active\\",\\n \\"ClientAffinity\\": \\"SOURCE_IP\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"CreateTime\\": 1577786252000,\\n \\"PortRanges\\": [\\n {\\n \\"FromPort\\": 20,\\n \\"ToPort\\": 20\\n }\\n ],\\n \\"Name\\": \\"Listener\\",\\n \\"ProxyProtocol\\": true,\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"XForwardedForConfig\\": {\\n \\"XForwardedForGaIdEnabled\\": false,\\n \\"XRealIpEnabled\\": false,\\n \\"XForwardedForGaApEnabled\\": false,\\n \\"XForwardedForProtoEnabled\\": false,\\n \\"XForwardedForPortEnabled\\": false\\n },\\n \\"SecurityPolicyId\\": \\"tls_cipher_policy_1_0\\",\\n \\"Type\\": \\"Standard\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"IdleTimeout\\": 900,\\n \\"RequestTimeout\\": 60,\\n \\"HttpVersion\\": \\"http2\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListListenersResponse>\\n <TotalCount>1</TotalCount>\\n <Listeners>\\n <Certificates>\\n <Type>Server</Type>\\n <Id>44983xxxx-cn-hangzhou</Id>\\n </Certificates>\\n <BackendPorts>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n </BackendPorts>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <Description>Listener</Description>\\n <State>active</State>\\n <ClientAffinity>SOURCE_IP</ClientAffinity>\\n <Protocol>TCP</Protocol>\\n <CreateTime>1577786252000</CreateTime>\\n <PortRanges>\\n <FromPort>20</FromPort>\\n <ToPort>20</ToPort>\\n </PortRanges>\\n <Name>Listener</Name>\\n <ProxyProtocol>true</ProxyProtocol>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <XForwardedForConfig>\\n <XForwardedForGaIdEnabled>false</XForwardedForGaIdEnabled>\\n <XRealIpEnabled>false</XRealIpEnabled>\\n <XForwardedForGaApEnabled>false</XForwardedForGaApEnabled>\\n <XForwardedForProtoEnabled>false</XForwardedForProtoEnabled>\\n <XForwardedForPortEnabled>false</XForwardedForPortEnabled>\\n </XForwardedForConfig>\\n <SecurityPolicyId>tls_cipher_policy_1_0</SecurityPolicyId>\\n </Listeners>\\n <PageSize>10</PageSize>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <PageNumber>1</PageNumber>\\n</ListListenersResponse>","errorExample":""}]', + 'title' => '查询监听列表', + 'summary' => '查询监听列表。', + 'description' => '本接口用于查询全球加速实例下的监听列表，包括各监听的路由类型、状态、创建的时间戳、端口信息等。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateListener' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8897', + 'abilityTreeNodes' => [ + 'FEATUREgaZW5ZHQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000 ', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Listener', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的描述信息。'."\n" + ."\n" + .'描述长度最大为200个字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'Listener', + ], + ], + [ + 'name' => 'ClientAffinity', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端亲和性。取值：'."\n" + ."\n" + .'- **NONE**：不保持客户端亲和性，即不能确保来自同一客户端的连接请求始终定向到同一终端节点。'."\n" + ."\n" + .'- **SOURCE_IP**：保持客户端亲和性。即客户端访问有状态的应用程序时，可以将来自同一客户端的所有请求都定向到同一终端节点，而不考虑源端口和协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'SOURCE_IP', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'description' => '监听的网络传输协议类型，取值：'."\n" + ."\n" + .'- **tcp**：TCP协议。'."\n" + ."\n" + .'- **udp**：UDP协议。'."\n" + ."\n" + .'- **http**：HTTP协议。'."\n" + ."\n" + .'- **https**：HTTPS协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'ProxyProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启保持客户端源IP功能。'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。开启后，支持后端服务查看客户端的原始IP地址。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n" + .'> 该参数后续将不在监听API中配置，建议在终端节点组的相关API中进行配置。关于**ProxyProtocol**，请参见[CreateEndpointGroup](~~153259~~)和[UpdateEndpointGroup](~~153262~~)。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PortRanges', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用来接收请求并向终端节点进行转发的端口范围。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '用来接收请求并向终端节点进行转发的端口范围。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的起始监听端口。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**，且需满足**FromPort**≤**ToPort**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。'."\n" + .'>对于HTTP或HTTPS协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'ToPort' => [ + 'description' => '用来接收请求并向终端节点进行转发的结束监听端口。'."\n" + ."\n" + .'可配置的监听端口范围为**1**~**65499**，且需满足**FromPort**≤**ToPort**。'."\n" + ."\n" + .'最多可配置端口数量与监听路由类型和监听协议类型相关，更多信息，请参见[监听端口](~~153216~~)。'."\n" + .'>对于HTTP或HTTPS协议的监听，只支持配置一个监听端口，即起始监听端口和结束监听端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '21', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Certificates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'SSL证书。', + 'type' => 'array', + 'items' => [ + 'description' => 'SSL证书。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'SSL证书ID。'."\n" + ."\n" + .'>仅HTTPS协议的监听需要配置该项。', + 'type' => 'string', + 'required' => false, + 'example' => '449****-cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'BackendPorts', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '后端服务器接收请求的端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '后端服务器接收请求的端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '后端服务器接收请求的起始端口。'."\n" + ."\n" + .'>当您的监听协议为HTTP或HTTPS，且监听的端口和后端服务器提供服务的端口不一致时才需填写该项。其中，后端服务器接收请求的起始端口和结束端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '后端服务器接收请求的结束端口。'."\n" + ."\n" + .'>当您的监听协议为HTTP或HTTPS，且监听的端口和后端服务器提供服务的端口不一致时才需填写该项。其中，后端服务器接收请求的起始端口和结束端口需相同。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'XForwardedForConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '`XForward`字段配置信息。', + 'type' => 'object', + 'properties' => [ + 'XForwardedForGaIdEnabled' => [ + 'description' => '是否通过`GA-ID`头字段获取全球加速实例ID。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForProtoEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Proto`字段获取全球加速实例的监听协议。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForPortEnabled' => [ + 'description' => '是否通过`GA-X-Forward-Port`字段获取全球加速实例的监听端口。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XRealIpEnabled' => [ + 'description' => '是否通过`X-Real-IP`字段获取真实的客户端IP。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'XForwardedForGaApEnabled' => [ + 'description' => '是否通过`GA-AP`字段获取加速地域信息。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 仅HTTP和HTTPS监听支持此参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SecurityPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全策略实例ID。取值：'."\n" + ."\n" + .'- **tls_cipher_policy_1_0**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.0、TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_1**'."\n" + ."\n" + .' - 支持的TLS版本： TLSv1.1和TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA和DES-CBC3-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2。'."\n" + ."\n" + .' - 支持的加密算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA和ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'- **tls_cipher_policy_1_2_strict_with_1_3**'."\n" + ."\n" + .' - 支持的TLS版本：TLSv1.2及TLSv1.3。'."\n" + ."\n" + .' - 支持的加密算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。'."\n" + ."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'tls_cipher_policy_1_0', + ], + ], + [ + 'name' => 'IdleTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '连接空闲超时时间。单位：秒。'."\n" + ."\n" + .'- TCP：10-900s，默认900s'."\n" + .'- UDP：10-20s ，默认20s '."\n" + .'- HTTP/HTTPS：1-60秒，默认15s ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '900', + ], + ], + [ + 'name' => 'RequestTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP/HTTPS的连接请求超时时间。单位：秒。'."\n" + ."\n" + .'可选：1-180s，默认60s。'."\n" + ."\n" + .'>仅对Protocol（网络传输协议类型）为HTTP或HTTPS的监听有效。如果在超时时间内后端服务器一直没有响应，全球加速将放弃等待，并给客户端返回HTTP 504错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'HttpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP协议的最大版本，取值：'."\n" + .'- **http3**：HTTP/3。'."\n" + .'- **http2**：HTTP/2。'."\n" + .'- **http1.1**：HTTP/1.1。'."\n" + .'> 仅HTTPS监听支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'http2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'PortRangeIllegal.Listener', + 'errorMessage' => 'The specified listener port range is invalid.', + ], + [ + 'errorCode' => 'PortConflict.Listener', + 'errorMessage' => 'The listener port configuration is in conflict.', + ], + [ + 'errorCode' => 'QuotaExceeded.ListenerPort', + 'errorMessage' => 'The maximum number of listener ports is exceeded.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'Exist.PortOverride', + 'errorMessage' => 'Port override exists.', + ], + [ + 'errorCode' => 'RegionNotSupportHugePort.Listener', + 'errorMessage' => 'The current ipSet or listener region does not support hugePort.', + ], + [ + 'errorCode' => 'PortRanges.MustOne', + 'errorMessage' => 'The portRanges must be one for HTTPS and HTTP type listener.', + ], + [ + 'errorCode' => 'SecurityPolicyIdIllegal.Listener', + 'errorMessage' => 'The listener security policy ID %s is illegal.', + ], + [ + 'errorCode' => 'SecurityPolicyId.NotNeed', + 'errorMessage' => 'No security policy ID is required for the listener.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateListenerResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n</UpdateListenerResponse>","errorExample":""}]', + 'title' => '修改监听', + 'summary' => '调用UpdateListener接口修改全球加速实例下指定监听的配置。', + 'description' => '本接口用于修改指定监听的协议、端口等信息，使监听配置满足您的业务需求。'."\n" + ."\n" + .'在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- **UpdateListener**接口属于异步接口，即系统会先返回一个请求ID，但监听配置并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**updating**状态时，表示监听配置正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示监听配置修改完成。'."\n" + .'- **UpdateListener**接口不支持在同一个全球加速实例内并发修改监听配置。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteListener' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7854', + 'abilityTreeNodes' => [ + 'FEATUREgaZW5ZHQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000 ', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的监听的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\"\\n}","type":"json"}]', + 'title' => '删除监听', + 'summary' => '调用DeleteListener接口删除监听。', + 'description' => '- 调用**DeleteListener**接口前，请确保要删除的监听下不存在终端节点组。删除终端节点组，请参见：'."\n" + .' - [DeleteEndpointGroup](~~2253305~~)：删除智能路由类型监听关联的终端节点组。'."\n" + .' - [DeleteEndpointGroups](~~2253311~~)：批量删除智能路由类型监听关联的终端节点组。'."\n" + .' - [DeleteCustomRoutingEndpointGroups](~~2303183~~)：批量删除自定义路由类型监听关联的终端节点组。'."\n" + .'- **DeleteListener**接口属于异步接口，即系统会先返回一个请求ID，但监听并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**deleting**状态时，表示监听正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该监听时，表示监听删除完成。'."\n" + .'- **DeleteListener**接口不支持在同一个全球加速实例内并发删除监听。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetHealthStatus' => [ + 'summary' => '调用GetHealthStatus接口获取指定监听下终端节点组和终端节点的健康状态信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35853', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会获取监听实例的健康状态信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并获取监听实例的健康状态信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'HealthStatus' => [ + 'description' => '监听下终端节点组和终端节点的健康状态。取值：'."\n" + .'- **normal**：正常。'."\n" + .'- **abnormal**：异常。'."\n" + .'- **partiallyAbnormal**：部分异常。', + 'type' => 'string', + 'example' => 'normal', + ], + 'EndpointGroups' => [ + 'description' => '终端节点组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组的ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'EndpointGroupType' => [ + 'description' => '终端节点组类型。取值：'."\n" + .'- **default**：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。', + 'type' => 'string', + 'example' => 'default', + ], + 'HealthStatus' => [ + 'description' => '终端节点组的健康状态。取值：'."\n" + .'- **init**：初始化'."\n" + .'- **normal**：正常。'."\n" + .'- **abnormal**：异常。'."\n" + .'- **partiallyAbnormal**：部分异常。'."\n", + 'type' => 'string', + 'example' => 'normal', + ], + 'ForwardingRuleIds' => [ + 'description' => '转发策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略ID列表。', + 'type' => 'string', + 'example' => 'frule-bp134k63nmtwmnwee****', + ], + ], + 'Endpoints' => [ + 'description' => '终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-hp33b2e43fays7s8****', + ], + 'Address' => [ + 'description' => '终端节点地址。', + 'type' => 'string', + 'example' => '47.0.XX.XX', + ], + 'HealthStatus' => [ + 'description' => '终端节点的健康状态。取值：'."\n" + .'- **init**：初始化'."\n" + .'- **normal**：正常。'."\n" + .'- **abnormal**：异常。', + 'type' => 'string', + 'example' => 'normal', + ], + 'HealthDetail' => [ + 'description' => '终端节点的健康检查明细。'."\n" + ."\n" + .'> 该参数暂未启用。'."\n" + ."\n", + 'type' => 'string', + 'example' => '无', + ], + 'Port' => [ + 'description' => '终端节点的端口。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'Type' => [ + 'description' => '终端节点类型。取值： '."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云CLB实例（原SLB）。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'Ip', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"HealthStatus\\": \\"normal\\",\\n \\"EndpointGroups\\": [\\n {\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointGroupType\\": \\"default\\",\\n \\"HealthStatus\\": \\"normal\\",\\n \\"ForwardingRuleIds\\": [\\n \\"frule-bp134k63nmtwmnwee****\\"\\n ],\\n \\"Endpoints\\": [\\n {\\n \\"EndpointId\\": \\"ep-hp33b2e43fays7s8****\\",\\n \\"Address\\": \\"47.0.XX.XX\\",\\n \\"HealthStatus\\": \\"normal\\",\\n \\"HealthDetail\\": \\"无\\",\\n \\"Port\\": 80,\\n \\"Type\\": \\"Ip\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetHealthStatusResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <HealthStatus>normal</HealthStatus>\\n <EndpointGroups>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <EndpointGroupType>default</EndpointGroupType>\\n <HealthStatus>normal</HealthStatus>\\n <ForwardingRuleIds>frule-bp134k63nmtwmnwee****</ForwardingRuleIds>\\n <Endpoints>\\n <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>\\n <Address>47.0.XX.XX</Address>\\n <HealthStatus>normal</HealthStatus>\\n <HealthDetail>无</HealthDetail>\\n <Port>80</Port>\\n <Type>Ip</Type>\\n </Endpoints>\\n </EndpointGroups>\\n</GetHealthStatusResponse>","errorExample":""}]', + 'title' => '获取监听下终端节点组和终端节点的健康状态', + ], + 'AssociateAdditionalCertificatesWithListener' => [ + 'summary' => '为全球加速HTTPS协议监听绑定多个证书，并结合虚拟终端节点组和转发策略功能，可实现加速访问多个HTTPS域名。您可以调用AssociateAdditionalCertificatesWithListener接口为HTTPS监听绑定扩展证书。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '42918', + 'abilityTreeNodes' => [ + 'FEATUREga38GCGA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。仅支持HTTPS的监听。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'Certificates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扩展证书列表。'."\n" + ."\n" + .'一次最多支持输入10个证书信息。', + 'type' => 'array', + 'items' => [ + 'description' => '扩展证书列表。'."\n" + ."\n" + .'一次最多支持输入10个证书信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '证书ID，当前仅支持服务器证书。'."\n" + ."\n" + .'一次最多支持输入10个证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6092**-cn-hangzhou', + ], + 'Domain' => [ + 'description' => '证书指定生效的域名。一个域名只能绑定一个扩展证书。'."\n" + ."\n" + .'一次最多支持输入10个域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'ProtocalIllegal.Listener', + 'errorMessage' => 'The specified listener protocol is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.Listener', + 'errorMessage' => 'The maximum number of listeners is exceeded.', + ], + [ + 'errorCode' => 'PortRangeIllegal.Listener', + 'errorMessage' => 'The specified listener port range is invalid.', + ], + [ + 'errorCode' => 'PortConflict.Listener', + 'errorMessage' => 'The listener port configuration is in conflict.', + ], + [ + 'errorCode' => 'QuotaExceeded.ListenerPort', + 'errorMessage' => 'The maximum number of listener ports is exceeded.', + ], + [ + 'errorCode' => 'PortRangeIllegal.ExceedGaAbility', + 'errorMessage' => 'The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).', + ], + [ + 'errorCode' => 'PortRangeIllegal.UDP', + 'errorMessage' => 'UDP ports 250, 4789, and 4790 are system reserved ports.', + ], + [ + 'errorCode' => 'SystemPort.Listener', + 'errorMessage' => 'Ports 65500-65535 are system reserved ports.', + ], + [ + 'errorCode' => 'PortRanges.MustOne', + 'errorMessage' => 'The portRanges must be one for HTTPS and HTTP type listener.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateAdditionalCertificatesWithListenerResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n</AssociateAdditionalCertificatesWithListenerResponse>","errorExample":""}]', + 'title' => '为HTTPS监听绑定扩展证书', + 'description' => '- 仅HTTPS协议的监听支持绑定扩展证书。'."\n" + .'- **AssociateAdditionalCertificatesWithListener**接口属于异步接口，即系统会先返回一个请求ID，但HTTPS监听和扩展证书并未绑定完成，系统后台的关联任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**updating**状态时，表示HTTPS监听和扩展证书正在绑定中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示HTTPS监听和扩展证书绑定完成。'."\n" + .'- **AssociateAdditionalCertificatesWithListener**接口不支持在同一个全球加速实例内并发为HTTPS监听绑定扩展证书。', + ], + 'DissociateAdditionalCertificatesFromListener' => [ + 'summary' => '调用DissociateAdditionalCertificatesFromListener接口将扩展证书与HTTPS监听解绑。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '43184', + 'abilityTreeNodes' => [ + 'FEATUREga38GCGA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'Domains', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扩展证书绑定的域名。', + 'type' => 'array', + 'items' => [ + 'description' => '扩展证书绑定的域名。'."\n" + ."\n" + .'您一次最多可输入10个域名。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AlreadyInBandwidthPackage.Accelerator', + 'errorMessage' => 'The accelerated instance is already in the bandwidth package.', + ], + [ + 'errorCode' => 'BandwidthIllegal.BandwidthPackage', + 'errorMessage' => 'The bandwidth of the basic bandwidth package must be lower than or equal to the bandwidth of the cross-domain bandwidth package.', + ], + [ + 'errorCode' => 'BindExist.Accelerator', + 'errorMessage' => 'The accelerated instance is already bound to a bandwidth package.', + ], + [ + 'errorCode' => 'BindExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package is already bound.', + ], + [ + 'errorCode' => 'BindExist.EndPointGroup', + 'errorMessage' => 'The endpoint group %s contains binding.', + ], + [ + 'errorCode' => 'EndPointGroupTypeIllegal.EndpointGroup', + 'errorMessage' => 'The endpoint group type is illegal.', + ], + [ + 'errorCode' => 'EndPointRequestProtocolIllegal.EndpointGroup', + 'errorMessage' => 'The endpoint group request protocol is illegal.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'Exist.ForwardingRule', + 'errorMessage' => 'The forwarding rule already exists.', + ], + [ + 'errorCode' => 'Exist.IpSet', + 'errorMessage' => 'The IpSet already exists.', + ], + [ + 'errorCode' => 'Exist.Listener', + 'errorMessage' => 'The listener already exists.', + ], + [ + 'errorCode' => 'Exist.VirtualEndpointGroup', + 'errorMessage' => 'A virtual endpoint group already exists.', + ], + [ + 'errorCode' => 'GaSpecExceeded.IpSet', + 'errorMessage' => 'The number of IpSet exceeds the specification of the GA instance.', + ], + [ + 'errorCode' => 'GreaterThanGa.IpSetBandwidth', + 'errorMessage' => 'The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.', + ], + [ + 'errorCode' => 'IllegalBandwidth.IpSet', + 'errorMessage' => 'The bandwidth of IpSet is invalid.', + ], + [ + 'errorCode' => 'IllegalParameter.BandwidthType', + 'errorMessage' => 'The parameter BandwidthType is illegal.', + ], + [ + 'errorCode' => 'IllegalParameter.Spec', + 'errorMessage' => 'The specified Spec is invalid.', + ], + [ + 'errorCode' => 'IllegalParameter.Type', + 'errorMessage' => 'The specified Type is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.BandwidthType', + 'errorMessage' => 'You must specify BandwidthType.', + ], + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NoPermission.GaDdosRoleSession', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'NotActive.IpSet', + 'errorMessage' => 'The state of IpSet is not active.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'NotExist.BandwidthPackage', + 'errorMessage' => 'The bandwidth package does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'NotExist.IpSets', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'The listening port %s does not exist.', + ], + [ + 'errorCode' => 'NotInBandwidthPackage.Accelerator', + 'errorMessage' => 'The accelerated instance is not in the bandwidth package.', + ], + [ + 'errorCode' => 'PortConflict.Listener', + 'errorMessage' => 'The listener port configuration is in conflict.', + ], + [ + 'errorCode' => 'PortRangeIllegal.Count', + 'errorMessage' => 'The hugePort listener only supports one port range.', + ], + [ + 'errorCode' => 'PortRangeIllegal.Listener', + 'errorMessage' => 'The specified listener port range is invalid.', + ], + [ + 'errorCode' => 'PortRanges.MustOne', + 'errorMessage' => 'The portRanges must be one for HTTPS and HTTP type listener.', + ], + [ + 'errorCode' => 'ProtocalIllegal.Listener', + 'errorMessage' => 'The specified listener protocol is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.ForwardingRule', + 'errorMessage' => 'The number of forwarding rule exceeds the limit.', + ], + [ + 'errorCode' => 'QuotaExceeded.Listener', + 'errorMessage' => 'The maximum number of listeners is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.ListenerPort', + 'errorMessage' => 'The maximum number of listener ports is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.PortOverride', + 'errorMessage' => 'The number of port override exceeds the limit.', + ], + [ + 'errorCode' => 'QuotaExceeded.RuleConditionConfig', + 'errorMessage' => 'The number of path and host exceeds the limit.', + ], + [ + 'errorCode' => 'RegionRepeat.IpSet', + 'errorMessage' => 'Only one IpSet can be created in an accelerated region.', + ], + [ + 'errorCode' => 'Repeat.IpSets', + 'errorMessage' => 'The configuration of IpSet is duplicated.', + ], + [ + 'errorCode' => 'RepeatPathAndHost.ForwardingRule', + 'errorMessage' => 'The path and host %s are duplicated.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackage', + 'errorMessage' => 'The state of bandwidth package is invalid.', + ], + [ + 'errorCode' => 'StateError.BandwidthPackageBind', + 'errorMessage' => 'The state of binding for the bandwidth package is invalid.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'StateError.ForwardingRule', + 'errorMessage' => 'The forwarding rule state %s is illegal.', + ], + [ + 'errorCode' => 'StateError.IpSet', + 'errorMessage' => 'The state of IpSet is invalid.', + ], + [ + 'errorCode' => 'TooManySpareIp.Accelerator', + 'errorMessage' => 'Too many SpareIp accepted under the same Accelerator', + ], + [ + 'errorCode' => 'UpgradeError.BandwidthPackage', + 'errorMessage' => 'The bandwidth package configurations should be either all upgrades or all downgrades.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateAdditionalCertificatesFromListenerResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</DissociateAdditionalCertificatesFromListenerResponse>","errorExample":""}]', + 'title' => '将扩展证书与HTTPS监听解绑', + 'description' => '- **DissociateAdditionalCertificatesFromListener**接口属于异步接口，即系统会先返回一个请求ID，但HTTPS监听和扩展证书并未解绑完成，系统后台的解绑任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**updating**状态时，表示HTTPS监听和扩展证书正在解绑中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示HTTPS监听和扩展证书解绑完成。'."\n" + .'- **DissociateAdditionalCertificatesFromListener**接口不支持在同一个全球加速实例内并发为HTTPS监听解绑扩展证书。', + ], + 'UpdateAdditionalCertificateWithListener' => [ + 'summary' => '当原证书过期需替换为新的证书且关联域名不变时，您可以调用UpdateAdditionalCertificateWithListener接口为HTTPS监听替换扩展证书。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157568', + 'abilityTreeNodes' => [ + 'FEATUREga38GCGA', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会替换扩展证书。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。仅支持HTTPS协议类型的监听。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '原扩展证书绑定的域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'CertificateId', + 'in' => 'query', + 'schema' => [ + 'description' => '新的证书ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6092**-cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'ResourceNotFound.CertificateDomain', + 'errorMessage' => 'The specified domain is not found.', + ], + [ + 'errorCode' => 'CertificateNotSupportDomain', + 'errorMessage' => 'The certificate does not support the current domain, please check.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAdditionalCertificateWithListenerResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n</UpdateAdditionalCertificateWithListenerResponse>","errorExample":""}]', + 'title' => '为HTTPS监听替换扩展证书', + 'description' => '本接口用于替换扩展证书。仅适用于原证书过期，需替换为新的证书且关联域名不变的场景。'."\n" + ."\n" + .'- **UpdateAdditionalCertificateWithListener**接口属于异步接口，即系统会先返回一个请求ID，但HTTPS监听的扩展证书并未替换完成，系统后台的替换任务仍在进行。您可以调用[ListListenerCertificates](~~307743~~)查询监听绑定的证书状态：'."\n" + ."\n" + .' - 当待替换证书处于**updating**状态时，表示HTTPS监听的扩展证书正在替换中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当新证书处于**active**状态时，表示HTTPS监听的扩展证书替换完成并已生效。'."\n" + ."\n" + .'- **UpdateAdditionalCertificateWithListener**接口不支持在同一个全球加速实例内并发为HTTPS监听替换扩展证书。', + ], + 'ListListenerCertificates' => [ + 'summary' => '调用ListListenerCertificates接口查询监听绑定的证书列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '证书的角色。取值：'."\n" + .'- **default**：默认证书。'."\n" + .'- **additional**：扩展证书。'."\n" + ."\n" + .'不传入值时，默认证书和扩展证书都将返回在证书列表中。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'enum' => [ + 'additional', + 'default', + ], + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次读取的最大数据记录数量。'."\n" + .'取值范围：**1**~**50**，默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '50', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'MaxResults' => [ + 'description' => '本次读取的最大数据记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Certificates' => [ + 'description' => '证书列表。', + 'type' => 'array', + 'items' => [ + 'description' => '证书列表。', + 'type' => 'object', + 'properties' => [ + 'CertificateId' => [ + 'description' => '证书ID。', + 'type' => 'string', + 'example' => '6092**-cn-hangzhou', + ], + 'IsDefault' => [ + 'description' => '是否为默认证书。'."\n" + .'- **true**：默认证书。'."\n" + .'- **false**：扩展证书。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Domain' => [ + 'description' => '扩展证书绑定的域名。'."\n" + ."\n" + .'默认证书不返回该字段。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'State' => [ + 'description' => '证书的状态。'."\n" + .'- **active**：证书绑定监听并生效。'."\n" + .'- **updating**：扩展证书替换中。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"MaxResults\\": 20,\\n \\"Certificates\\": [\\n {\\n \\"CertificateId\\": \\"6092**-cn-hangzhou\\",\\n \\"IsDefault\\": true,\\n \\"Domain\\": \\"example.com\\",\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListListenerCertificatesResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <MaxResults>20</MaxResults>\\n <Certificates>\\n <CertificateId>6092**-cn-hangzhou</CertificateId>\\n <IsDefault>true</IsDefault>\\n <Domain>example.com</Domain>\\n <State>active</State>\\n </Certificates>\\n</ListListenerCertificatesResponse>","errorExample":""}]', + 'title' => '查询监听绑定的证书列表', + ], + 'ListSystemSecurityPolicies' => [ + 'summary' => '调用ListSystemSecurityPolicies接口查询HTTPS监听支持的TLS系统安全策略列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '90922', + 'abilityTreeNodes' => [ + 'FEATUREgaVX8KJ1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数，最大值为**100**，默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9B4E54C-9CCD-4002-91A9-D38C6C209192', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '每页包含的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityPolicies' => [ + 'description' => '安全策略列表.', + 'type' => 'array', + 'items' => [ + 'description' => '安全策略列表。', + 'type' => 'object', + 'properties' => [ + 'SecurityPolicyId' => [ + 'description' => '安全策略ID。', + 'type' => 'string', + 'example' => 'tls_cipher_policy_1_1', + ], + 'TlsVersions' => [ + 'description' => '支持的TLS协议版本，取值：**TLSv1.0**、**TLSv1.1**、**TLSv1.2**和**TLSv1.3**。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的TLS协议版本，取值：**TLSv1.0**、**TLSv1.1**、**TLSv1.2**和**TLSv1.3**。', + 'type' => 'string', + 'example' => '["TLSv1.0","TLSv1.2"]', + ], + ], + 'Ciphers' => [ + 'description' => '支持的加密套件列表。具体依赖**TLSVersions**的取值。'."\n" + ."\n" + .'Cipher只要被任何一个传入的**TLSVersions**支持即可，例如选择了**TLSv1.3**，那么Cipher列表必须包含**TLSv1.3**支持的Cipher。'."\n" + ."\n" + .'- **TLSv1.0**和**TLSv1.1**支持：'."\n" + .' - ECDHE-ECDSA-AES128-SHA'."\n" + .' - ECDHE-ECDSA-AES256-SHA'."\n" + .' - ECDHE-RSA-AES128-SHA'."\n" + .' - ECDHE-RSA-AES256-SHA'."\n" + .' - AES128-SHA'."\n" + .' - AES256-SHA'."\n" + .' - DES-CBC3-SHA'."\n" + ."\n" + .'- **TLSv1.2**支持：'."\n" + .' - ECDHE-ECDSA-AES128-SHA'."\n" + .' - ECDHE-ECDSA-AES256-SHA'."\n" + .' - ECDHE-RSA-AES128-SHA'."\n" + .' - ECDHE-RSA-AES256-SHA'."\n" + .' - AES128-SHA'."\n" + .' - AES256-SHA'."\n" + .' - DES-CBC3-SHA'."\n" + .' - ECDHE-ECDSA-AES128-GCM-SHA256'."\n" + .' - ECDHE-ECDSA-AES256-GCM-SHA384'."\n" + .' - ECDHE-ECDSA-AES128-SHA256'."\n" + .' - ECDHE-ECDSA-AES256-SHA384'."\n" + .' - ECDHE-RSA-AES128-GCM-SHA256'."\n" + .' - ECDHE-RSA-AES256-GCM-SHA384'."\n" + .' - ECDHE-RSA-AES128-SHA256'."\n" + .' - ECDHE-RSA-AES256-SHA384'."\n" + .' - AES128-GCM-SHA256'."\n" + .' - AES256-GCM-SHA384'."\n" + .' - AES128-SHA256'."\n" + .' - AES256-SHA256'."\n" + ."\n" + .'- **TLSv1.3**支持：'."\n" + .' - TLS_AES_128_GCM_SHA256'."\n" + .' - TLS_AES_256_GCM_SHA384'."\n" + .' - TLS_CHACHA20_POLY1305_SHA256'."\n" + .' - TLS_AES_128_CCM_SHA256'."\n" + .' - TLS_AES_128_CCM_8_SHA256', + 'type' => 'array', + 'items' => [ + 'description' => '支持的加密套件列表。具体依赖**TLSVersions**的取值。'."\n" + ."\n" + .'Cipher只要被任何一个传入的**TLSVersions**支持即可，例如选择了**TLSv1.3**，那么Cipher列表必须包含**TLSv1.3**支持的Cipher。'."\n" + ."\n" + .'- **TLSv1.0**和**TLSv1.1**支持：'."\n" + .' - **ECDHE-ECDSA-AES128-SHA**'."\n" + .' - **ECDHE-ECDSA-AES256-SHA**'."\n" + .' - **ECDHE-RSA-AES128-SHA**'."\n" + .' - **ECDHE-RSA-AES256-SHA**'."\n" + .' - **AES128-SHA**'."\n" + .' - **AES256-SHA**'."\n" + .' - **DES-CBC3-SHA**'."\n" + .'- **TLSv1.2**支持：'."\n" + .' - **ECDHE-ECDSA-AES128-SHA**'."\n" + .' - **ECDHE-ECDSA-AES256-SHA**'."\n" + .' - **ECDHE-RSA-AES128-SHA**'."\n" + .' - **ECDHE-RSA-AES256-SHA**'."\n" + .' - **AES128-SHA**'."\n" + .' - **AES256-SHA**'."\n" + .' - **DES-CBC3-SHA**'."\n" + .' - **ECDHE-ECDSA-AES128-GCM-SHA256**'."\n" + .' - **ECDHE-ECDSA-AES256-GCM-SHA384**'."\n" + .' - **ECDHE-ECDSA-AES128-SHA256**'."\n" + .' - **ECDHE-ECDSA-AES256-SHA384**'."\n" + .' - **ECDHE-RSA-AES128-GCM-SHA256**'."\n" + .' - **ECDHE-RSA-AES256-GCM-SHA384**'."\n" + .' - **ECDHE-RSA-AES128-SHA256**'."\n" + .' - **ECDHE-RSA-AES256-SHA384**'."\n" + .' - **AES128-GCM-SHA256**'."\n" + .' - **AES256-GCM-SHA384**'."\n" + .' - **AES128-SHA256**'."\n" + .' - **AES256-SHA256**'."\n" + .'- **TLSv1.3**支持：'."\n" + .' - **TLS_AES_128_GCM_SHA256**'."\n" + .' - **TLS_AES_256_GCM_SHA384**'."\n" + .' - **TLS_CHACHA20_POLY1305_SHA256**'."\n" + .' - **TLS_AES_128_CCM_SHA256**'."\n" + .' - **TLS_AES_128_CCM_8_SHA256**'."\n", + 'type' => 'string', + 'example' => '["ECDHE-ECDSA-AES128-SHA","ECDHE-RSA-AES128-GCM-SHA256"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A9B4E54C-9CCD-4002-91A9-D38C6C209192\\",\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"SecurityPolicies\\": [\\n {\\n \\"SecurityPolicyId\\": \\"tls_cipher_policy_1_1\\",\\n \\"TlsVersions\\": [\\n \\"[\\\\\\"TLSv1.0\\\\\\",\\\\\\"TLSv1.2\\\\\\"]\\"\\n ],\\n \\"Ciphers\\": [\\n \\"[\\\\\\"ECDHE-ECDSA-AES128-SHA\\\\\\",\\\\\\"ECDHE-RSA-AES128-GCM-SHA256\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSystemSecurityPoliciesResponse>\\n <RequestId>A9B4E54C-9CCD-4002-91A9-D38C6C209192</RequestId>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <SecurityPolicies>\\n <SecurityPolicyId>tls_cipher_policy_1_1</SecurityPolicyId>\\n <TlsVersions>[\\"TLSv1.0\\",\\"TLSv1.2\\"]</TlsVersions>\\n <Ciphers>[\\"ECDHE-ECDSA-AES128-SHA\\",\\"ECDHE-RSA-AES128-GCM-SHA256\\"]</Ciphers>\\n </SecurityPolicies>\\n</ListSystemSecurityPoliciesResponse>","errorExample":""}]', + 'title' => '查询HTTPS监听支持的TLS系统安全策略列表', + 'description' => '在创建和配置HTTPS监听时，支持使用TLS安全策略。本接口用于查询HTTPS监听支持的TLS系统安全策略。', + ], + 'CreateEndpointGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7846', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000 ', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'EndpointGroup', + ], + ], + [ + 'name' => 'EndpointGroupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'TrafficPercentage', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。'."\n" + .'取值范围：**1**~**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'HealthCheckIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的时间间隔，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'HealthCheckPath', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/healthcheck', + ], + ], + [ + 'name' => 'HealthCheckPort', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'HealthCheckProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的协议。取值：'."\n" + ."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + ."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + ."\n" + .'- **https**或**HTTPS**：HTTPS协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'ThresholdCount', + 'in' => 'query', + 'schema' => [ + 'description' => '针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。'."\n" + .'取值范围：**2**~**10**。默认值：**3**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'EndpointConfigurations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点类型，取值：'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。'."\n" + ."\n" + .'> - 终端节点类型取值为**ECS**、**ENI**、**SLB**、**ALB**、**NLB**或**IpTarget**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。'."\n" + .'> - 终端节点类型取值为**ALB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。'."\n" + .'> - 终端节点类型取值为**OSS**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。'."\n" + .'> - 终端节点类型取值为**NLB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaNlb的服务关联角色。'."\n" + .'>> 更多信息，请参见[服务关联角色](~~178360~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Ip', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否使用自动获取方式开启保持客户端源 IP 功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n\n" + .'>- UDP/TCP 监听对应的终端节点组默认不开启保持客户端源IP，您可根据业务需要配置。'."\n" + .'>- HTTP（S）监听对应的终端节点组默认开启保持客户端源IP，通过X-Forwarded-For头字段获取。不支持关闭。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Weight' => [ + 'description' => '终端节点的权重。'."\n" + ."\n" + .'取值范围：**0**~**255**。'."\n" + ."\n" + .'> 如果某个终端节点的权重设置为0，全球加速将终止向该终端节点分发流量，请您谨慎操作。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + .'>- 仅支持TCP监听对应的终端节点组配置。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Endpoint' => [ + 'description' => '根据Type（终端节点类型）输入对应的IP、域名或实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '120.1.XX.XX', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n" + ."\n" + .'> 当终端节点类型为**ENI**时，可以选择配置该参数，如果不配置默认为ENI的主私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.X.X', + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入1个专有网络ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1quce3451z5b2hv****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入2个虚拟交换机ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。'."\n" + .'> - 该虚拟交换机属于**VpcId**参数指定的专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp12mho4ze51ezagm****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EndpointRequestProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '后端服务协议。取值：'."\n" + ."\n" + .'- **HTTP**（默认值）'."\n" + .'- **HTTPS**'."\n" + ."\n" + .'> - 仅为**HTTP**或**HTTPS**协议的监听实例创建终端节点组时才支持配置该项。'."\n" + .'> - 对于**HTTP**协议的监听实例，后端服务协议支持且仅支持**HTTP**。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'EndpointProtocolVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '后端服务协议版本。取值：'."\n" + ."\n" + .'- **HTTP1.1**（默认值）：HTTP1.1版本。'."\n" + ."\n" + .'- **HTTP2**：HTTP2协议。'."\n" + ."\n" + .'> 仅当EndpointRequestProtocol（后端服务协议）值为HTTPS时，支持配置终端节点后端服务协议版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP1.1', + ], + ], + [ + 'name' => 'EndpointGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组类型。取值：'."\n" + ."\n" + .'- **default**（默认值）：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。'."\n" + ."\n" + .'> 为四层监听创建虚拟终端节点组时，请确保已创建默认终端节点组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + 'default' => 'default', + 'enum' => [ + 'default', + 'virtual', + ], + ], + ], + [ + 'name' => 'PortOverrides', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '配置端口映射时的监听端口。'."\n" + ."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '配置端口映射时的终端节点端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'HealthCheckEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启健康检查。取值：'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**：关闭健康检查。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '终端节点组的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-key', + ], + 'Value' => [ + 'description' => '终端节点组的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'HealthCheckHost', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.taobao.com', + ], + ], + [ + 'name' => 'EndpointIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '后端IP地址协议。取值： '."\n" + .'- **IPv4**：（默认值）：GA仅使用IPv4地址与终端节点服务通信。 '."\n" + .'- **IPv6**：GA仅使用IPv6地址与终端节点服务通信。 '."\n" + .'- **ProtocolAffinity**：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Domain.NotFit', + 'errorMessage' => 'The domain is not fit the rule', + ], + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'The listening port %s does not exist.', + ], + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'EndPointRequestProtocolIllegal.EndpointGroup', + 'errorMessage' => 'endpoint group request protoco is illegal', + ], + [ + 'errorCode' => 'QuotaExceeded.PortOverride', + 'errorMessage' => 'The number of port override exceeds the limit.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEndpointGroupResponse>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateEndpointGroupResponse>","errorExample":""}]', + 'title' => '创建终端节点组', + 'summary' => '创建终端节点组。', + 'description' => '- 调用本接口为四层协议监听创建虚拟终端节点组时，请确保已创建默认终端节点组。'."\n" + .'- **CreateEndpointGroup**接口属于异步接口，即系统会先返回一个终端节点组ID，但终端节点组并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + ."\n" + .' - 当终端节点组处于**init**状态时，表示终端节点组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组创建完成。'."\n" + ."\n" + .'- **CreateEndpointGroup**接口不支持在同一个全球加速实例内并发创建终端节点组。', + ], + 'DescribeEndpointGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7857', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的终端节点组的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'HealthCheckIntervalSeconds' => [ + 'description' => '健康检查的时间间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TrafficPercentage' => [ + 'description' => '监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'Description' => [ + 'description' => '终端节点组的描述信息。', + 'type' => 'string', + 'example' => 'group1', + ], + 'EndpointGroupIpList' => [ + 'description' => '终端节点组活跃的终端节点IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组活跃的终端节点IP列表。', + 'type' => 'string', + 'example' => '101.XX.XX.22', + ], + ], + 'EndpointGroupUnconfirmedIpList' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'string', + 'example' => '101.XX.XX.22', + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + 'HealthCheckPath' => [ + 'description' => '健康检查路径。', + 'type' => 'string', + 'example' => '/healthcheck', + ], + 'ThresholdCount' => [ + 'description' => '健康检查判定终端节点为不健康的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Name' => [ + 'description' => '终端节点组的名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'State' => [ + 'description' => '终端节点组的状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：正常。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'HealthCheckProtocol' => [ + 'description' => '健康检查的协议。'."\n" + ."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + ."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + ."\n" + .'- **https**或**HTTPS**：HTTPS协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'HealthCheckPort' => [ + 'description' => '健康检查的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'EndpointConfigurations' => [ + 'description' => '终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点类型。'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'Ip', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否开启了自动获取方式开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **true**：开启了保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**：未开启保持客户端源IP功能。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Weight' => [ + 'description' => '终端节点的权重。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '255', + ], + 'ProbeProtocol' => [ + 'description' => '时延探测协议。'."\n" + .'- **tcp**：TCP协议。'."\n" + .'- **icmp**：ICMP协议。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'tcp', + ], + 'Endpoint' => [ + 'description' => '终端节点的IP、域名或实例ID。', + 'type' => 'string', + 'example' => '120.XX.XX.21', + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启了保持客户端源IP功能。'."\n" + ."\n" + .'- **true**：使用ProxyProtocol方式开启了保持客户端源IP功能。'."\n" + ."\n" + .'- **false**：未使用ProxyProtocol方式开启保持客户端源IP功能。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ProbePort' => [ + 'description' => '延时监控的探测端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。', + 'type' => 'string', + 'example' => '172.168.XX.XX', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-hp30gtnxkfxj1l2xt****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1nx4sxxe1nnr1ja****', + ], + 'maxItems' => 10, + ], + ], + ], + ], + 'PortOverrides' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '终端节点端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + 'EndpointRequestProtocol' => [ + 'description' => '后端服务协议。'."\n" + ."\n" + .'- **HTTP**'."\n" + .'- **HTTPS**', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'EndpointProtocolVersion' => [ + 'description' => '后端服务协议版本。'."\n" + ."\n" + .'- **HTTP1.1**'."\n" + .'- **HTTP2**', + 'type' => 'string', + 'example' => 'HTTP2', + ], + 'EndpointGroupType' => [ + 'description' => '终端节点组类型。'."\n" + ."\n" + .'- **default**：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。', + 'type' => 'string', + 'example' => 'default', + ], + 'ForwardingRuleIds' => [ + 'description' => '终端节点组关联的转发策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组关联的转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'SlsRegion' => [ + 'description' => 'SLS地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SlsProjectName' => [ + 'description' => 'SLS项目名称。', + 'type' => 'string', + 'example' => 'pn-01', + ], + 'SlsLogStoreName' => [ + 'description' => 'SLS日志库名称。', + 'type' => 'string', + 'example' => 'lsn-01', + ], + 'AccessLogSwitch' => [ + 'description' => '日志绑定状态。'."\n" + .'- **on**：已绑定。'."\n" + .'- **off**：未绑定。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。', + 'type' => 'string', + 'example' => 'on', + ], + 'EnableAccessLog' => [ + 'description' => '是否开启了访问日志。'."\n" + .'- **true**：开启访问日志。'."\n" + .'- **false**：关闭访问日志。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HealthCheckEnabled' => [ + 'description' => '是否开启了健康检查。'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**：关闭健康检查。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称。'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型。'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管。'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行**Action**指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行**Action**指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '终端节点组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '终端节点组的标签键。', + 'type' => 'string', + 'example' => 'test-key', + ], + 'Value' => [ + 'description' => '终端节点组的标签值。', + 'type' => 'string', + 'example' => 'test-value', + ], + ], + ], + ], + 'HealthCheckHost' => [ + 'description' => '健康检查域名。', + 'type' => 'string', + 'example' => 'www.taobao.com', + ], + 'AccessLogRecordCustomizedHeadersEnabled' => [ + 'description' => '访问日志是否开启携带自定义头字段。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 只有实例访问日志开关**AccessLogEnabled**打开时，才能设置此参数为**true**。', + 'type' => 'boolean', + ], + 'AccessLogRecordCustomizedHeaderList' => [ + 'description' => '访问日志携带自定义头字段名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '访问日志携带自定义头字段名称列表', + 'type' => 'string', + 'example' => '[\'sda\', \'dsaasdd\', \'dsada\']', + ], + ], + 'EndpointIpVersion' => [ + 'description' => '后端IP地址协议。取值： '."\n" + .'- **IPv4**：（默认值）：GA仅使用IPv4地址与终端节点服务通信。 '."\n" + .'- **IPv6**：GA仅使用IPv6地址与终端节点服务通信。 '."\n" + .'- **ProtocolAffinity**：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'EndpointPrivateIpList' => [ + 'description' => '后端节点私有IP列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivateIp' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'VSwitchId' => [ + 'description' => 'VPC下的交换机ID', + 'type' => 'string', + 'example' => 'gsw-bp1rsfd2frym**', + ], + 'CIDR' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HealthCheckIntervalSeconds\\": 3,\\n \\"TrafficPercentage\\": 100,\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"Description\\": \\"group1\\",\\n \\"EndpointGroupIpList\\": [\\n \\"101.XX.XX.22\\"\\n ],\\n \\"EndpointGroupUnconfirmedIpList\\": [\\n \\"101.XX.XX.22\\"\\n ],\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\",\\n \\"HealthCheckPath\\": \\"/healthcheck\\",\\n \\"ThresholdCount\\": 3,\\n \\"Name\\": \\"group1\\",\\n \\"EndpointGroupRegion\\": \\"cn-hangzhou\\",\\n \\"State\\": \\"active\\",\\n \\"HealthCheckProtocol\\": \\"tcp\\",\\n \\"HealthCheckPort\\": 20,\\n \\"EndpointConfigurations\\": [\\n {\\n \\"Type\\": \\"Ip\\",\\n \\"EnableClientIPPreservation\\": false,\\n \\"Weight\\": 255,\\n \\"ProbeProtocol\\": \\"tcp\\",\\n \\"Endpoint\\": \\"120.XX.XX.21\\",\\n \\"EnableProxyProtocol\\": false,\\n \\"ProbePort\\": 80,\\n \\"SubAddress\\": \\"172.168.XX.XX\\",\\n \\"VpcId\\": \\"vpc-hp30gtnxkfxj1l2xt****\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp1nx4sxxe1nnr1ja****\\"\\n ]\\n }\\n ],\\n \\"PortOverrides\\": [\\n {\\n \\"ListenerPort\\": 443,\\n \\"EndpointPort\\": 80\\n }\\n ],\\n \\"EndpointRequestProtocol\\": \\"HTTP\\",\\n \\"EndpointProtocolVersion\\": \\"HTTP2\\",\\n \\"EndpointGroupType\\": \\"default\\",\\n \\"ForwardingRuleIds\\": [\\n \\"frule-bp19a3t3yzr21q3****\\"\\n ],\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"SlsRegion\\": \\"cn-hangzhou\\",\\n \\"SlsProjectName\\": \\"pn-01\\",\\n \\"SlsLogStoreName\\": \\"lsn-01\\",\\n \\"AccessLogSwitch\\": \\"on\\",\\n \\"EnableAccessLog\\": true,\\n \\"HealthCheckEnabled\\": true,\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ],\\n \\"HealthCheckHost\\": \\"www.taobao.com\\",\\n \\"AccessLogRecordCustomizedHeadersEnabled\\": true,\\n \\"AccessLogRecordCustomizedHeaderList\\": [\\n \\"[\'sda\', \'dsaasdd\', \'dsada\']\\"\\n ],\\n \\"EndpointIpVersion\\": \\"IPv4\\",\\n \\"EndpointPrivateIpList\\": [\\n {\\n \\"PrivateIp\\": \\"172.16.49.***\\",\\n \\"VSwitchId\\": \\"gsw-bp1rsfd2frym**\\",\\n \\"CIDR\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeEndpointGroupResponse>\\n <HealthCheckIntervalSeconds>3</HealthCheckIntervalSeconds>\\n <TrafficPercentage>20</TrafficPercentage>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <Description>group1</Description>\\n <EndpointGroupIpList>101.XX.XX.22</EndpointGroupIpList>\\n <EndpointGroupUnconfirmedIpList>101.XX.XX.22</EndpointGroupUnconfirmedIpList>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n <HealthCheckPath>/healthcheck</HealthCheckPath>\\n <ThresholdCount>3</ThresholdCount>\\n <Name>group1</Name>\\n <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>\\n <State>active</State>\\n <HealthCheckProtocol>tcp</HealthCheckProtocol>\\n <HealthCheckPort>20</HealthCheckPort>\\n <EndpointConfigurations>\\n <Type>Ip</Type>\\n <EnableClientIPPreservation>false</EnableClientIPPreservation>\\n <Weight>20</Weight>\\n <ProbeProtocol>tcp</ProbeProtocol>\\n <Endpoint>120.XX.XX.21</Endpoint>\\n <EnableProxyProtocol>false</EnableProxyProtocol>\\n <ProbePort>80</ProbePort>\\n </EndpointConfigurations>\\n <PortOverrides>\\n <ListenerPort>443</ListenerPort>\\n <EndpointPort>80</EndpointPort>\\n </PortOverrides>\\n <EndpointRequestProtocol>HTTP</EndpointRequestProtocol>\\n <EndpointGroupType>default</EndpointGroupType>\\n <ForwardingRuleIds>frule-bp19a3t3yzr21q3****</ForwardingRuleIds>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <SlsRegion>cn-hangzhou</SlsRegion>\\n <SlsProjectName>pn-01</SlsProjectName>\\n <SlsLogStoreName>lsn-01</SlsLogStoreName>\\n <AccessLogSwitch>on</AccessLogSwitch>\\n <EnableAccessLog>false</EnableAccessLog>\\n <HealthCheckEnabled>true</HealthCheckEnabled>\\n <Tags>\\n <Key>test-key</Key>\\n <Value>test-value</Value>\\n </Tags>\\n</DescribeEndpointGroupResponse>","errorExample":""}]', + 'title' => '查询指定终端节点组信息', + 'summary' => '查询指定终端节点组信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEndpointGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8508', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**50**，默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组类型。取值：'."\n" + ."\n" + .'- **default**：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。'."\n" + .'- 空值：表示查询所有默认终端节点组和虚拟终端节点组。', + 'type' => 'string', + 'required' => false, + 'example' => 'virtual', + 'enum' => [ + 'default', + 'virtual', + ], + ], + ], + [ + 'name' => 'AccessLogSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启访问日志。取值：'."\n" + .'- **on**：开启访问日志。'."\n" + .'- **off**（默认值）：关闭访问日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '终端节点组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '终端节点组的标签键。'."\n" + .'一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '终端节点组的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A052D49E-CCC2-41DB-816C-DC3381503194 ', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndpointGroups' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + 'EndpointGroupIpList' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'string', + 'example' => '47.1.XX.XX', + ], + ], + 'EndpointGroupUnconfirmedIpList' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'string', + 'example' => '47.1.XX.XX', + ], + ], + 'State' => [ + 'description' => '终端节点组的状态。'."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：正常。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **deleteing**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'HealthCheckPath' => [ + 'description' => '健康检查路径。', + 'type' => 'string', + 'example' => '/healthcheck', + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'HealthCheckIntervalSeconds' => [ + 'description' => '健康检查的时间间隔，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TrafficPercentage' => [ + 'description' => '监听有多个终端节点组时，配置到不同终端节点组的流量比例。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'HealthCheckProtocol' => [ + 'description' => '健康检查的协议。'."\n" + ."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + ."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + ."\n" + .'- **https**或**HTTPS**：HTTPS协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'ThresholdCount' => [ + 'description' => '健康检查判定终端节点为不健康的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'EndpointConfigurations' => [ + 'description' => '终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点类型。'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'Ip', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否开启了自动获取方式开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **true**：开启了保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**：未开启保持客户端源IP功能。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Weight' => [ + 'description' => '终端节点的权重。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ProbeProtocol' => [ + 'description' => '延时监控的探测协议。'."\n" + ."\n" + .'- **icmp**：ICMP协议。'."\n" + ."\n" + .'- **tcp**：TCP协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'Endpoint' => [ + 'description' => '终端节点的IP、域名或实例ID。', + 'type' => 'string', + 'example' => '47.1.XX.XX', + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启了保持客户端源IP功能。'."\n" + ."\n" + .'- **true**：使用ProxyProtocol方式开启了保持客户端源IP功能。'."\n" + ."\n" + .'- **false**：未使用ProxyProtocol方式开启保持客户端源IP功能。', + 'type' => 'boolean', + ], + 'ProbePort' => [ + 'description' => '延时监控的探测端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp1d2utp8qqe2a44t****', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n", + 'type' => 'string', + 'example' => '172.168.XX.XX', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-8vbhucmd5b2q2fpqqu****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-hp3xwc2aebg2u30ln****', + ], + 'maxItems' => 10, + ], + ], + ], + ], + 'PortOverrides' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '监听端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '终端节点端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + 'ForwardingRuleIds' => [ + 'description' => '终端节点组关联的转发策略ID。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组关联的转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + ], + 'EndpointGroupType' => [ + 'description' => '终端节点组类型。'."\n" + .'- **default**：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。', + 'type' => 'string', + 'example' => 'default', + ], + 'EndpointRequestProtocol' => [ + 'description' => '后端服务协议。'."\n" + ."\n" + .'- **HTTP**：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'EndpointProtocolVersion' => [ + 'description' => '后端服务协议版本。'."\n" + ."\n" + .'- **HTTP1.1**：HTTP1.1版本。'."\n" + .'- **HTTP2**：HTTP2版本。', + 'type' => 'string', + 'example' => 'HTTP1.1', + ], + 'Description' => [ + 'description' => '终端节点组的描述信息。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Name' => [ + 'description' => '终端节点组的名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'HealthCheckPort' => [ + 'description' => '健康检查的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HealthCheckEnabled' => [ + 'description' => '是否开启了健康检查。'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**：关闭健康检查。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称。'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型。'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '终端节点组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '终端节点组的标签键。', + 'type' => 'string', + 'example' => 'test-key', + ], + 'Value' => [ + 'description' => '终端节点组的标签值。', + 'type' => 'string', + 'example' => 'test-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + 'HealthCheckHost' => [ + 'description' => '健康检查域名。', + 'type' => 'string', + 'example' => 'www.taobao.com', + ], + 'EndpointIpVersion' => [ + 'description' => '后端IP地址协议。取值： '."\n" + .'- **IPv4**：（默认值）：GA仅使用IPv4地址与终端节点服务通信。 '."\n" + .'- **IPv6**：GA仅使用IPv6地址与终端节点服务通信。 '."\n" + .'- **ProtocolAffinity**：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'EndpointPrivateIpList' => [ + 'description' => '后端节点私有IP列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrivateIp' => [ + 'description' => '私有IP。', + 'type' => 'string', + 'example' => '172.19.115.37', + ], + 'VSwitchId' => [ + 'description' => 'VPC下的交换机ID', + 'type' => 'string', + 'example' => 'gsw-0jl6tmriqep1ga***', + ], + 'CIDR' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A052D49E-CCC2-41DB-816C-DC3381503194\\\\t\\",\\n \\"PageNumber\\": 1,\\n \\"EndpointGroups\\": [\\n {\\n \\"EndpointGroupId\\": \\"epg-bp16jdc00bhe97sr5****\\",\\n \\"EndpointGroupIpList\\": [\\n \\"47.1.XX.XX\\"\\n ],\\n \\"EndpointGroupUnconfirmedIpList\\": [\\n \\"47.1.XX.XX\\"\\n ],\\n \\"State\\": \\"active\\",\\n \\"HealthCheckPath\\": \\"/healthcheck\\",\\n \\"EndpointGroupRegion\\": \\"cn-hangzhou\\",\\n \\"HealthCheckIntervalSeconds\\": 3,\\n \\"TrafficPercentage\\": 100,\\n \\"HealthCheckProtocol\\": \\"tcp\\",\\n \\"ThresholdCount\\": 3,\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"EndpointConfigurations\\": [\\n {\\n \\"Type\\": \\"Ip\\",\\n \\"EnableClientIPPreservation\\": false,\\n \\"Weight\\": 20,\\n \\"ProbeProtocol\\": \\"tcp\\",\\n \\"Endpoint\\": \\"47.1.XX.XX\\",\\n \\"EnableProxyProtocol\\": true,\\n \\"ProbePort\\": 80,\\n \\"EndpointId\\": \\"ep-bp1d2utp8qqe2a44t****\\",\\n \\"SubAddress\\": \\"172.168.XX.XX\\",\\n \\"VpcId\\": \\"vpc-8vbhucmd5b2q2fpqqu****\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-hp3xwc2aebg2u30ln****\\"\\n ]\\n }\\n ],\\n \\"PortOverrides\\": [\\n {\\n \\"ListenerPort\\": 443,\\n \\"EndpointPort\\": 80\\n }\\n ],\\n \\"ForwardingRuleIds\\": [\\n \\"frule-bp19a3t3yzr21q3****\\"\\n ],\\n \\"EndpointGroupType\\": \\"default\\",\\n \\"EndpointRequestProtocol\\": \\"HTTP\\",\\n \\"EndpointProtocolVersion\\": \\"HTTP1.1\\",\\n \\"Description\\": \\"group1\\",\\n \\"Name\\": \\"group1\\",\\n \\"HealthCheckPort\\": 10,\\n \\"HealthCheckEnabled\\": true,\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"test-key\\",\\n \\"Value\\": \\"test-value\\"\\n }\\n ],\\n \\"HealthCheckHost\\": \\"www.taobao.com\\",\\n \\"EndpointIpVersion\\": \\"IPv4\\",\\n \\"EndpointPrivateIpList\\": [\\n {\\n \\"PrivateIp\\": \\"172.19.115.37\\",\\n \\"VSwitchId\\": \\"gsw-0jl6tmriqep1ga***\\",\\n \\"CIDR\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEndpointGroupsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>A052D49E-CCC2-41DB-816C-DC3381503194\\t</RequestId>\\n <PageNumber>1</PageNumber>\\n <EndpointGroups>\\n <EndpointGroupId>epg-bp16jdc00bhe97sr5****</EndpointGroupId>\\n <EndpointGroupIpList>47.1.XX.XX</EndpointGroupIpList>\\n <EndpointGroupUnconfirmedIpList>47.1.XX.XX</EndpointGroupUnconfirmedIpList>\\n <State>active</State>\\n <HealthCheckPath>/healthcheck</HealthCheckPath>\\n <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>\\n <HealthCheckIntervalSeconds>3</HealthCheckIntervalSeconds>\\n <TrafficPercentage>20</TrafficPercentage>\\n <HealthCheckProtocol>tcp</HealthCheckProtocol>\\n <ThresholdCount>3</ThresholdCount>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <EndpointConfigurations>\\n <Type>Ip</Type>\\n <EnableClientIPPreservation>false</EnableClientIPPreservation>\\n <Weight>20</Weight>\\n <ProbeProtocol>tcp</ProbeProtocol>\\n <Endpoint>47.1.XX.XX</Endpoint>\\n <ProbePort>80</ProbePort>\\n <EndpointId>ep-bp1d2utp8qqe2a44t****</EndpointId>\\n </EndpointConfigurations>\\n <PortOverrides>\\n <ListenerPort>443</ListenerPort>\\n <EndpointPort>80</EndpointPort>\\n </PortOverrides>\\n <ForwardingRuleIds>frule-bp19a3t3yzr21q3****</ForwardingRuleIds>\\n <EndpointGroupType>default</EndpointGroupType>\\n <EndpointRequestProtocol>HTTP</EndpointRequestProtocol>\\n <Description>group1</Description>\\n <Name>group1</Name>\\n <HealthCheckPort>10</HealthCheckPort>\\n <HealthCheckEnabled>true</HealthCheckEnabled>\\n <Tags>\\n <Key>test-key</Key>\\n <Value>test-value</Value>\\n </Tags>\\n </EndpointGroups>\\n</ListEndpointGroupsResponse>","errorExample":""}]', + 'title' => '查询终端节点组列表', + 'summary' => '查询终端节点组列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateEndpointGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8509', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'EndpointGroup', + ], + ], + [ + 'name' => 'EndpointGroupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TrafficPercentage', + 'in' => 'query', + 'schema' => [ + 'description' => '监听有多个终端节点组时的权重。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'HealthCheckIntervalSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的时间间隔。单位：秒。取值范围：**1**-**50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'HealthCheckPath', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/healthcheck', + ], + ], + [ + 'name' => 'HealthCheckPort', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的端口。取值范围：**1**~**65535**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'HealthCheckProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '健康检查的协议。取值：'."\n" + ."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + ."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + ."\n" + .'- **https**或**HTTPS**：HTTPS协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTPS', + ], + ], + [ + 'name' => 'ThresholdCount', + 'in' => 'query', + 'schema' => [ + 'description' => '针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。'."\n" + ."\n" + .'取值范围：**2**~**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'EndpointConfigurations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点类型，取值：'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。'."\n" + ."\n" + .'> - 终端节点类型取值为**ECS**、**ENI**、**SLB**、**ALB**、**NLB**或**IpTarget**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。'."\n" + .'> - 终端节点类型取值为**ALB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。'."\n" + .'> - 终端节点类型取值为**OSS**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。'."\n" + .'> - 终端节点类型取值为**NLB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaNlb的服务关联角色。'."\n" + .' > > 更多信息，请参见[服务关联角色](~~178360~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Ip', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否使用自动获取方式开启保持客户端源 IP 功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n\n" + .'>- UDP/TCP 监听对应的终端节点组默认不开启保持客户端源IP，您可根据业务需要配置。'."\n" + .'>- HTTP（S）监听对应的终端节点组默认开启保持客户端源IP，通过X-Forwarded-For头字段获取。不支持关闭。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Weight' => [ + 'description' => '终端节点的权重。'."\n" + ."\n" + .'取值范围：**0**~**255**。'."\n" + ."\n" + .'> 如果某个终端节点的权重设置为0，全球加速将终止向该终端节点分发流量，请您谨慎操作。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + .'>- 仅支持TCP监听对应的终端节点组配置。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Endpoint' => [ + 'description' => '根据Type（终端节点类型）输入对应的IP、域名或实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '120.XX.XX.21', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n" + ."\n" + .'> 当终端节点类型为**ENI**时，可以选择配置该参数，如果不配置默认为ENI的主私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.XX.XX', + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入1个专有网络ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zen6t0u7xhm0k5iz****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入2个虚拟交换机ID。'."\n" + .'> 仅当终端节点类型为IpTarget时有效且必填。'."\n" + .'> - 该虚拟交换机属于VpcId参数指定的专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze2dbtkxabpvpqxc****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'EndpointRequestProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '后端服务协议。取值：'."\n" + ."\n" + .'- **HTTP**'."\n" + .'- **HTTPS**'."\n" + ."\n" + .'> - 仅为HTTP或HTTPS协议的监听实例创建终端节点组时才支持配置该项。'."\n" + .'> - 对于HTTP协议的监听实例，后端服务协议支持且仅支持HTTP。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'EndpointProtocolVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '后端服务协议版本。取值：'."\n" + ."\n" + .'- **HTTP1.1**'."\n" + ."\n" + .'- **HTTP2**'."\n" + ."\n" + .'> 仅当EndpointRequestProtocol（后端服务协议）值为HTTPS时，支持配置终端节点后端服务协议版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP1.1', + ], + ], + [ + 'name' => 'PortOverrides', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '配置端口映射中的监听端口。'."\n" + ."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '配置端口映射中的终端节点端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'HealthCheckEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启健康检查。取值：'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**（默认值）：关闭健康检查。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HealthCheckHost', + 'in' => 'query', + 'schema' => [ + 'description' => '健康域名检查', + 'type' => 'string', + 'required' => false, + 'example' => 'www.taobao.com', + ], + ], + [ + 'name' => 'EndpointIpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '后端IP地址协议。取值：'."\n" + .'● IPv4（默认值）：GA仅使用IPv4地址与终端节点服务通信。'."\n" + .'● IPv6：GA仅使用IPv6地址与终端节点服务通信。'."\n" + .'● ProtocolAffinity：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'EndPointRequestProtocolIllegal.EndpointGroup', + 'errorMessage' => 'endpoint group request protoco is illegal', + ], + [ + 'errorCode' => 'QuotaExceeded.PortOverride', + 'errorMessage' => 'The number of port override exceeds the limit.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'listener port %s is not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEndpointGroupResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8\\t</RequestId>\\n</UpdateEndpointGroupResponse>","errorExample":""}]', + 'title' => '修改终端节点组的业务配置', + 'summary' => '修改终端节点组配置信息。', + 'description' => '- **UpdateEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组配置信息并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组配置信息正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组配置信息修改完成。'."\n" + .'- **UpdateEndpointGroup**接口不支持在同一个全球加速实例内并发修改终端节点组配置信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateEndpointGroupAttribute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8894', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅支持取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1ple63864a5hyj5****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的终端节点组的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的终端节点组的描述。'."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'testEndpointGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEndpointGroupAttributeResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</UpdateEndpointGroupAttributeResponse>","errorExample":""}]', + 'title' => '修改终端节点组的名称和描述', + 'summary' => '调用UpdateEndpointGroupAttribute接口修改终端节点组的名称和描述。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEndpointGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7851', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000 ', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8 ', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\\\t\\"\\n}","type":"json"}]', + 'title' => '删除终端节点组', + 'summary' => '调用DeleteEndpointGroup接口删除终端节点组。', + 'description' => '- **DeleteEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**deleting**状态时，表示终端节点组正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该终端节点组时，表示终端节点组删除完成。'."\n" + .'- **DeleteEndpointGroup**接口不支持在同一个全球加速实例内并发删除终端节点组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogStoreOfEndpointGroup' => [ + 'summary' => '调用DescribeLogStoreOfEndpointGroup接口查询终端节点组关联的SLS日志库信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '153954', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-xxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-xxxxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '返回信息列表。', + 'type' => 'string', + 'example' => '1777E713-8456-55F1-9A69-9AD9EAE2B3B6', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-xxxxxxxxxxxxx', + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-xxxxxxxxxxxxxxx', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-xxxxxxxxxxxxxxx', + ], + 'SlsRegionId' => [ + 'description' => '日志服务所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SlsProjectName' => [ + 'description' => '日志服务项目（Project）名称。', + 'type' => 'string', + 'example' => 'ga_project_name', + ], + 'SlsLogStoreName' => [ + 'description' => '日志库（Logstore）名称。', + 'type' => 'string', + 'example' => 'ga_log', + ], + 'Status' => [ + 'description' => '访问日志绑定状态。'."\n" + ."\n" + .'- **on**：已绑定。'."\n" + ."\n" + .'- **off**：未绑定。', + 'type' => 'string', + 'example' => 'on', + ], + 'AccessLogRecordCustomizedHeadersEnabled' => [ + 'type' => 'boolean', + ], + 'AccessLogRecordCustomizedHeaderList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1777E713-8456-55F1-9A69-9AD9EAE2B3B6\\",\\n \\"AcceleratorId\\": \\"ga-xxxxxxxxxxxxx\\",\\n \\"ListenerId\\": \\"lsr-xxxxxxxxxxxxxxx\\",\\n \\"EndpointGroupId\\": \\"epg-xxxxxxxxxxxxxxx\\",\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"SlsProjectName\\": \\"ga_project_name\\",\\n \\"SlsLogStoreName\\": \\"ga_log\\",\\n \\"Status\\": \\"on\\",\\n \\"AccessLogRecordCustomizedHeadersEnabled\\": true,\\n \\"AccessLogRecordCustomizedHeaderList\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询终端节点组关联的SLS日志库', + ], + 'AttachLogStoreToEndpointGroup' => [ + 'summary' => '调用AttachLogStoreToEndpointGroup接口关联SLS日志库到终端节点组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '17771', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SlsProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLS项目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'pn-01', + ], + ], + [ + 'name' => 'SlsLogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLS日志库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lsn-01', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'SlsRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SLS地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EndpointGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '[\'epg-bp1dmlohjjz4kqaun****\',\'epg-bp1v1u72cx35ogofe****\', ...]', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AccessLogRecordCustomizedHeaderList', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AccessLogRecordCustomizedHeadersEnabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'NotSupportAccessLog.Accelerator', + 'errorMessage' => 'Currently Accelerator does not support access log feature', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachLogStoreToEndpointGroupResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</AttachLogStoreToEndpointGroupResponse>","errorExample":""}]', + 'title' => '关联SLS日志库到终端节点组', + 'description' => '- **AttachLogStoreToEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但SLS日志库与终端节点组并未关联完成，系统后台的关联任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**updating**状态时，表示SLS日志库与终端节点组正在关联中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示SLS日志库与终端节点组关联完成。'."\n" + .'- **AttachLogStoreToEndpointGroup**接口不支持在同一个全球加速实例内并发关联SLS日志库与终端节点组。', + ], + 'DetachLogStoreFromEndpointGroup' => [ + 'summary' => '调用DetachLogStoreFromEndpointGroup接口解除SLS日志库和终端节点组的关联关系。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '[\'epg-bp1dmlohjjz4kqaun****\',\'epg-bp1v1u72cx35ogofe****\', ...]', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachLogStoreFromEndpointGroupResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n</DetachLogStoreFromEndpointGroupResponse>","errorExample":""}]', + 'title' => '解除SLS日志库和终端节点组的关联关系', + 'description' => '- **DetachLogStoreFromEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但SLS日志库和终端节点组的关联关系并未解除完成，系统后台的解关联任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**updating**状态时，表示SLS日志库和终端节点组正在解关联中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示SLS日志库和终端节点组的关联关系解除完成。'."\n" + .'- **DetachLogStoreFromEndpointGroup**接口不支持在同一个全球加速实例内并发解除SLS日志库和终端节点组的关联关系。', + ], + 'CreateEndpointGroups' => [ + 'summary' => '创建终端节点组列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35744', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回 HTTP 2xx 状态码。'."\n" + ."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。'."\n" + ."\n" + .'> 当该监听协议为**HTTP**或**HTTPS**时，调用**CreateEndpointGroups**接口每次仅支持创建一个终端节点组。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupConfigurations', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'您最多可以输入10个终端节点组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'您最多可以输入10个终端节点组信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupName' => [ + 'description' => '终端节点组的名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + 'EndpointGroupDescription' => [ + 'description' => '终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大 200 字符，不能以http://和https://开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'EndpointGroup', + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属地域ID。'."\n" + ."\n" + .'您最多可以输入10个终端节点组地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hongkong', + ], + 'TrafficPercentage' => [ + 'description' => '流量调配值，即智能路由类型监听有多个终端节点组时，配置到不同终端节点组的流量比例。'."\n" + ."\n" + .'取值范围：**1**~**100**。默认值：**100**。'."\n" + ."\n" + .'您最多可以输入10个终端节点组的流量调配值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'HealthCheckEnabled' => [ + 'description' => '是否为智能路由类型监听的终端节点组开启健康检查。取值：'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**（默认值）：关闭健康检查。'."\n" + ."\n" + .'您最多可以开启10个终端节点组的健康检查。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HealthCheckIntervalSeconds' => [ + 'description' => '健康检查的时间间隔，单位：秒。'."\n" + ."\n" + .'您最多可以输入10个健康检查的时间间隔。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'HealthCheckPath' => [ + 'description' => '健康检查路径。'."\n" + ."\n" + .'您最多可以输入10个健康检查路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/healthcheck', + ], + 'HealthCheckPort' => [ + 'description' => '健康检查的端口。取值范围：**1**~**65535**。'."\n" + ."\n" + .'您最多可以输入10个健康检查的端口。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '443', + ], + 'HealthCheckProtocol' => [ + 'description' => '健康检查的协议。取值：'."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + .'- **https**或**HTTPS**：HTTPS协议。'."\n" + ."\n" + .'您最多可以输入10个健康检查的协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTPS', + ], + 'ThresholdCount' => [ + 'description' => '针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。'."\n" + .'取值范围：**2**~**10**。默认值：**3**。'."\n" + ."\n" + .'您最多可以输入10个健康检查状态变化所需要的连续健康检查次数值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'EndpointConfigurations' => [ + 'description' => '智能路由类型监听的终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '智能路由类型监听的终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '智能路由类型监听的终端节点类型。取值：'."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB 实例。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入100个终端节点类型。'."\n" + .'>- 当**Type**（监听路由类型）值为**Standard**（智能路由类型）时，支持配置智能路由类型监听的终端节点组和终端节点信息，且该参数必填。'."\n" + .'>- 终端节点类型取值为**ECS**、**ENI**、**SLB**、**ALB**、**NLB**或**IpTarget**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。'."\n" + .'>- 终端节点类型取值为**ALB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。'."\n" + .'>- 终端节点类型取值为**OSS**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。'."\n" + .'>- 终端节点类型取值为**NLB**时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaNlb的服务关联角色。'."\n" + .'>> 更多信息，请参见[服务关联角色](~~178360~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Domain', + ], + 'Weight' => [ + 'description' => '终端节点的权重。'."\n" + ."\n" + .'取值范围：**0**~**255**。'."\n" + ."\n" + .'> 如果某个终端节点的权重设置为0，全球加速将终止向该终端节点分发流量，请您谨慎操作。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '255', + ], + 'Endpoint' => [ + 'description' => '智能路由类型监听的终端节点的IP或域名。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入100个终端节点的IP或域名。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.1.1', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n" + ."\n" + .'> 当终端节点类型为**ENI**时，可以选择配置该参数，如果不配置默认为ENI的主私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.XX.XX', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否使用自动获取方式开启保持客户端源 IP 功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n\n" + .'>- UDP/TCP 监听对应的终端节点组默认不开启保持客户端源IP，您可根据业务需要配置。'."\n" + .'>- HTTP（S）监听对应的终端节点组默认开启保持客户端源IP，通过X-Forwarded-For头字段获取。不支持关闭。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + .'>- 仅支持TCP监听对应的终端节点组配置。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入1个专有网络ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zekzii824szm3hps****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入2个虚拟交换机ID。'."\n" + .'> 仅当终端节点类型为IpTarget时有效且必填。'."\n" + .'> - 该虚拟交换机属于VpcId参数指定的专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1b2qx7y2qqnbkan****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EndpointRequestProtocol' => [ + 'description' => '后端服务协议。取值：'."\n" + .'- **HTTP**：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。'."\n" + ."\n" + .'> - 仅为HTTP或HTTPS协议的监听实例创建终端节点组时才支持配置该项。'."\n" + .'> - 对于HTTP协议的监听实例，后端服务协议支持且仅支持HTTP。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTPS', + ], + 'EndpointProtocolVersion' => [ + 'description' => '智能路由类型监听的终端节点后端服务协议版本。取值：'."\n" + ."\n" + .'- **HTTP1.1**（默认值）：HTTP1.1版本。'."\n" + ."\n" + .'- **HTTP2**：HTTP2版本。'."\n" + ."\n" + .'> 仅当EndpointRequestProtocol（终端节点后端服务协议）值为HTTPS时，支持配置终端节点后端服务协议版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP1.1', + ], + 'EndpointGroupType' => [ + 'description' => '智能路由类型监听的终端节点组类型。取值：'."\n" + .'- **default**（默认值）：默认终端节点组。'."\n" + .'- **virtual**：虚拟终端节点组。'."\n" + ."\n" + .'您最多可以输入10个终端节点组类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'PortOverrides' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '监听端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**。'."\n" + ."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + 'EndpointPort' => [ + 'description' => '配置端口映射时的终端节点端口。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '443', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + 'Tag' => [ + 'description' => '终端节点组的标签', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '终端节点组的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'您最多可输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '终端节点组的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'SystemTag' => [ + 'description' => '该参数当前无实际意义，无需配置。', + 'type' => 'array', + 'items' => [ + 'description' => '该参数当前无实际意义，无需配置。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '该参数当前无实际意义，无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Value' => [ + 'description' => '该参数当前无实际意义，无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Scope' => [ + 'description' => '该参数当前无实际意义，无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'HealthCheckHost' => [ + 'description' => '健康检查域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.taobao.com', + ], + 'EndpointIpVersion' => [ + 'description' => '后端IP地址协议。取值： '."\n" + .'- **IPv4**：（默认值）：GA仅使用IPv4地址与终端节点服务通信。 '."\n" + .'- **IPv6**：GA仅使用IPv6地址与终端节点服务通信。 '."\n" + .'- **ProtocolAffinity**：GA与终端节点服务通信的IP协议与客户端请求使用的IP协议相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'EndpointGroupIds' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Domain.NotFit', + 'errorMessage' => 'The domain is not fit the rule', + ], + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NotSupportHealthCheck.Accelerator', + 'errorMessage' => 'Currently Accelerator does not support health check.', + ], + [ + 'errorCode' => 'EndpointGroupExclusive.Listener', + 'errorMessage' => 'All endpoint group must under the same listener.', + ], + [ + 'errorCode' => 'RegionConflict.EndpointGroup', + 'errorMessage' => 'Endpoint group under the same listener must have different region.', + ], + [ + 'errorCode' => 'ListenerProtocolIllegal.EndpointGroup', + 'errorMessage' => 'Listener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndpointGroup', + 'errorMessage' => 'The number of endpoint group exceeds the limit.', + ], + [ + 'errorCode' => 'ParamExclusive.EndpointGroupType', + 'errorMessage' => 'All endpoint group type group must be consistent.', + ], + [ + 'errorCode' => 'HealthCheckPath.Illegal', + 'errorMessage' => 'Health check path illegal.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'EndPointRequestProtocolIllegal.EndpointGroup', + 'errorMessage' => 'endpoint group request protoco is illegal', + ], + [ + 'errorCode' => 'QuotaExceeded.PortOverride', + 'errorMessage' => 'The number of port override exceeds the limit.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'listener port %s is not exist', + ], + [ + 'errorCode' => 'MixedVpc.EndPoint', + 'errorMessage' => 'VPC Endpoint cannot be mixed with other types of Endpoints.', + ], + [ + 'errorCode' => 'IllegalPublicIp.EndPoint', + 'errorMessage' => 'The public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"EndpointGroupIds\\": [\\n \\"epg-bp1dmlohjjz4kqaun****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateEndpointGroupsResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <EndpointGroupIds>epg-bp1dmlohjjz4kqaun****</EndpointGroupIds>\\n</CreateEndpointGroupsResponse>","errorExample":""}]', + 'title' => '创建终端节点组列表', + 'description' => '- 本接口用于批量创建终端节点组，但不支持同时创建默认终端节点组与虚拟终端节点组。'."\n" + .'- 本接口不支持为四层协议监听创建虚拟终端节点组。如需为四层协议监听创建虚拟终端节点组，请使用[CreateEndpointGroup](~~2302394~~)。'."\n" + .'- **CreateEndpointGroups**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组并未批量创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)或[ListEndpointGroups](~~153261~~)查询终端节点组的状态：'."\n" + ."\n" + .' - 当存在终端节点组处于**init**状态时，表示终端节点组正在批量创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当所有终端节点组处于**active**状态时，表示终端节点组批量创建完成。'."\n" + ."\n" + .'- **CreateEndpointGroups**接口不支持在同一个全球加速实例内并发创建终端节点组。', + ], + 'UpdateEndpointGroups' => [ + 'summary' => '批量修改某个监听下的终端节点组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35764', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会批量修改某个监听下的终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EndpointGroupConfigurations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupName' => [ + 'description' => '终端节点组的名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + 'EndpointGroupDescription' => [ + 'description' => '终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大 200 字符，不能以 http://和 https://开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + 'TrafficPercentage' => [ + 'description' => '监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。'."\n" + ."\n" + .'取值范围：**1**~**100**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'HealthCheckEnabled' => [ + 'description' => '是否开启健康检查。'."\n" + .'- **true**：开启健康检查。'."\n" + .'- **false**（默认值）：关闭健康检查。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'HealthCheckIntervalSeconds' => [ + 'description' => '健康检查的时间间隔。单位：秒。取值范围：**1**-**50**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'HealthCheckPath' => [ + 'description' => '健康检查路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/healthcheck', + ], + 'HealthCheckPort' => [ + 'description' => '健康检查的端口。'."\n" + ."\n" + .'取值范围：**1**~**65535**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'HealthCheckProtocol' => [ + 'description' => '健康检查的协议。'."\n" + .'- **tcp**或**TCP**：TCP协议。'."\n" + ."\n" + .'- **http**或**HTTP**：HTTP协议。'."\n" + ."\n" + .'- **https**或**HTTPS**：HTTPS协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + 'ThresholdCount' => [ + 'description' => '针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。'."\n" + ."\n" + .'取值范围：**2**~**10**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'EndpointConfigurations' => [ + 'description' => '终端节点配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点类型。'."\n" + ."\n" + .'- **Domain**：自定义域名。'."\n" + .'- **Ip**：自定义IP。'."\n" + .'- **IpTarget**：自定义私网IP。'."\n" + .'- **PublicIp**：阿里云公网IP。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **SLB**：阿里云SLB实例。'."\n" + .'- **ALB**：阿里云ALB实例。'."\n" + .'- **OSS**：阿里云OSS实例。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **NLB**：阿里云NLB实例。'."\n" + ."\n" + .'> - 终端节点类型取值为**ECS**、**ENI**、**SLB**、**ALB**、**NLB**或**IpTarget**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。'."\n" + .'> - 终端节点类型取值为**ALB**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。'."\n" + .'> - 终端节点类型取值为**OSS**时，如果服务关联角色不存在，系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。'."\n" + .'>>更多信息，请参见[服务关联角色](~~178360~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Ip', + ], + 'Weight' => [ + 'description' => '终端节点的权重。'."\n" + ."\n" + .'取值范围：**0**~**255**。'."\n" + ."\n" + .'> 如果某个终端节点的权重设置为0，全球加速将终止向该终端节点分发流量，请您谨慎操作。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + 'Endpoint' => [ + 'description' => '根据Type（终端节点类型）输入对应的IP、域名或实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '47.0.XX.XX', + ], + 'SubAddress' => [ + 'description' => '弹性网卡的私网IP地址。'."\n" + ."\n" + .'> - 当终端节点类型为ENI时，可以选择配置该参数，如果不配置默认为ENI的主私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.XX.XX', + ], + 'EnableClientIPPreservation' => [ + 'description' => '是否使用自动获取方式开启保持客户端源 IP 功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源 IP 功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + ."\n\n" + .'>- UDP/TCP 监听对应的终端节点组默认不开启保持客户端源IP，您可根据业务需要配置。'."\n" + .'>- HTTP（S）监听对应的终端节点组默认开启保持客户端源IP，通过X-Forwarded-For头字段获取。不支持关闭。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + ], + 'EnableProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式开启保持客户端源IP功能，取值：'."\n" + ."\n" + .'- **true**：开启保持客户端源IP功能。'."\n" + ."\n" + .'- **false**（默认值）：不开启保持客户端源IP功能。'."\n" + .'>- 仅支持TCP监听对应的终端节点组配置。'."\n" + .'>- EnableClientIPPreservation与 EnableProxyProtocol不能同时为 true。'."\n" + .'>- 更多信息请参考[保持客户端源IP](~~158080~~)。', + 'type' => 'boolean', + 'required' => false, + ], + 'VpcId' => [ + 'description' => '专有网络ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入1个专有网络ID。'."\n" + .'> 仅当终端节点类型为**IpTarget**时有效且必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf66oesmrqge1t2gs****', + ], + 'VSwitchIds' => [ + 'description' => 'VPC下的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。'."\n" + ."\n" + .'在智能路由类型监听的某个终端节点组中，您最多可以输入2个虚拟交换机ID。'."\n" + .'> 仅当终端节点类型为IpTarget时有效且必填。'."\n" + .'> - 该虚拟交换机属于VpcId参数指定的专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf6r0due94mypz1i9****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => true, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'EndpointRequestProtocol' => [ + 'description' => '后端服务协议。取值：'."\n" + .'- **HTTP**：HTTP协议。'."\n" + .'- **HTTPS**：HTTPS协议。'."\n" + ."\n" + .'> - 仅为HTTP或HTTPS协议的监听实例创建终端节点组时才支持配置该项。'."\n" + .'> - 对于HTTP协议的监听实例，后端服务协议支持且仅支持HTTP。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + 'EndpointProtocolVersion' => [ + 'description' => '智能路由类型监听的终端节点后端服务协议版本。取值：'."\n" + ."\n" + .'- **HTTP1.1**（默认值）：HTTP1.1版本。'."\n" + ."\n" + .'- **HTTP2**：HTTP2版本。'."\n" + ."\n" + .'> 仅当EndpointRequestProtocol（终端节点后端服务协议）值为HTTPS时，支持配置终端节点后端服务协议版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP1.1', + ], + 'PortOverrides' => [ + 'description' => '端口映射关系。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射关系。', + 'type' => 'object', + 'properties' => [ + 'ListenerPort' => [ + 'description' => '监听端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**。'."\n" + ."\n" + .'> - 对于TCP监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。'."\n" + .'>- 配置端口映射后，后续监听变更时有以下限制：除HTTP和HTTPS之间的协议切换以外，不支持修改监听协议。'."\n" + .'>- 监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为80-82，并配置端口映射至终端节点端口100-102时，后续修改监听端口范围时，不支持修改为80-81。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '443', + ], + 'EndpointPort' => [ + 'description' => '终端节点端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + 'EnableClientIPPreservationToa' => [ + 'description' => '是否使用TOA方式保留客户端源IP。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'EnableClientIPPreservationProxyProtocol' => [ + 'description' => '是否使用ProxyProtocol方式保留客户端源IP。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp1d2utp8qqe2a44t****', + ], + 'HealthCheckHost' => [ + 'type' => 'string', + 'required' => false, + ], + 'EndpointIpVersion' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'EndpointGroupIds' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'EndPointRequestProtocolIllegal.EndpointGroup', + 'errorMessage' => 'endpoint group request protoco is illegal', + ], + [ + 'errorCode' => 'QuotaExceeded.PortOverride', + 'errorMessage' => 'The number of port override exceeds the limit.', + ], + [ + 'errorCode' => 'NotExist.ListenerPort', + 'errorMessage' => 'listener port %s is not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"EndpointGroupIds\\": [\\n \\"epg-bp1dmlohjjz4kqaun****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateEndpointGroupsResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <EndpointGroupIds>[\'epg-bp1dmlohjjz4kqaun****\',\'epg-bp1v1u72cx35ogofe****\', ...]</EndpointGroupIds>\\n</UpdateEndpointGroupsResponse>","errorExample":""}]', + 'title' => '批量修改某个监听下的终端节点组', + 'description' => '### 使用说明'."\n" + .'- **UpdateEndpointGroups**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组配置信息并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)或[ListEndpointGroups](~~153261~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组配置信息正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组配置信息修改完成。'."\n" + .'- **UpdateEndpointGroups**接口不支持在同一个全球加速实例内并发修改终端节点组配置信息。', + ], + 'ConfigEndpointProbe' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '7843', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点类型。取值：'."\n" + .'- **Ip**：云下自定义IP。'."\n" + .'- **Domain**：云下自定义域名。'."\n" + .'- **EIP**：云上EIP。'."\n" + .'- **PublicIp**：云上公网IP。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Ip', + ], + ], + [ + 'name' => 'Endpoint', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点。', + 'type' => 'string', + 'required' => true, + 'example' => '127.0.XX.XX', + ], + ], + [ + 'name' => 'ProbeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '时延探测协议。取值：'."\n" + .'- **tcp**：TCP协议。'."\n" + .'- **icmp**：ICMP协议。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + [ + 'name' => 'ProbePort', + 'in' => 'query', + 'schema' => [ + 'description' => '时延探测端口。取值范围：**0**～**65535**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启时延探测。取值：'."\n" + ."\n" + .'- **true**：开启。'."\n" + ."\n" + .'- **false**（默认值）：不开启。', + 'type' => 'string', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回列表信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfigEndpointProbeResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n</ConfigEndpointProbeResponse>","errorExample":""}]', + 'title' => '配置终端节点时延探测', + 'summary' => '调用ConfigEndpointProbe接口配置终端节点时延探测。', + 'description' => '- **ConfigEndpointProbe**接口属于异步接口，即系统会先返回一个请求ID，但终端节点时延探测并未配置完成，系统后台的配置任务仍在进行。您可以通过调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态，以确认终端节点组中终端节点的时延探测配置是否完成：'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组中终端节点的时延探测正在配置中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组中终端节点时延探测配置完成。'."\n" + ."\n" + .'- **ConfigEndpointProbe**接口不支持在同一个全球加速实例内并发配置终端节点时延探测。', + ], + 'DeleteEndpointGroups' => [ + 'summary' => '调用DeleteEndpointGroups接口批量删除终端节点组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '35765', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '1F4B6A4A-C89E-489E-BAF1-52777EE148EF', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会删除资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EndpointGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组ID列表。'."\n" + ."\n" + .'一次最多支持输入10个终端节点组进行删除。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID列表。'."\n" + ."\n" + .'一次最多支持输入10个终端节点组进行删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BindExist.EndPointGroup', + 'errorMessage' => 'EndPointGroup %s exist bind.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\"\\n}","type":"json"}]', + 'title' => '删除终端节点组列表', + 'description' => '- **DeleteEndpointGroups**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeEndpointGroup](~~153260~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**deleting**状态时，表示终端节点组正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到要删除的终端节点组时，表示终端节点组删除完成。'."\n" + .'- **DeleteEndpointGroups**接口不支持在同一个全球加速实例内并发删除终端节点组。', + ], + 'CreateCustomRoutingEndpointGroups' => [ + 'summary' => '调用CreateCustomRoutingEndpointGroups接口批量创建自定义路由类型监听的终端节点组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146731', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建自定义路由类型终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建自定义路由类型终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义路由类型监听ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'您最多可以输入5个终端节点组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'您最多可以输入5个终端节点组信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属地域ID。'."\n" + ."\n" + .'您最多可以输入5个终端节点组地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'Name' => [ + 'description' => '终端节点组名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。'."\n" + ."\n" + .'最多可以输入5个终端节点组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Description' => [ + 'description' => '终端节点组的描述信息。'."\n" + ."\n" + .'描述长度最大256字符，不能包含`http://`和`https://`字符。'."\n" + ."\n" + .'最多可以输入5个终端节点组的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'DestinationConfigurations' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'每个终端节点组下，最多可输入20条映射端口范围和协议类型信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'每个终端节点组下，最多可输入20条映射端口范围和协议类型信息。', + 'type' => 'object', + 'properties' => [ + 'Protocols' => [ + 'description' => '终端节点组后端服务的协议类型。'."\n" + ."\n" + .'每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n\n" + .'每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'required' => false, + 'maxItems' => 4, + ], + 'FromPort' => [ + 'description' => '终端节点组后端服务起始端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'每个终端节点组下，最多可输入20条后端服务起始端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '终端节点组后端服务结束端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'每个终端节点组下，最多可输入20条后端服务结束端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'EndpointConfigurations' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'每个终端节点组下，最多可输入10个终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'每个终端节点组下，最多可输入10个终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点后端服务类型。取值：'."\n" + ."\n" + .' **PrivateSubNet**（默认值）：私网CIDR。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateSubNet', + ], + 'Endpoint' => [ + 'description' => '终端节点交换机（vSwitch）实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-test01', + ], + 'TrafficToEndpointPolicy' => [ + 'description' => '后端服务流量通行策略，取值：'."\n" + ."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **DenyAll**（默认值）：拒绝所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。'."\n" + .'您需要指定该通信目标的IP地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。', + 'type' => 'string', + 'required' => false, + 'example' => 'DenyAll', + ], + 'PolicyConfigurations' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入5个结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EndpointGroupIds' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组ID列表。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaua****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EndpointGroupIds\\": [\\n \\"epg-bp1dmlohjjz4kqaua****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomRoutingEndpointGroupsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EndpointGroupIds>epg-bp1dmlohjjz4kqaua****</EndpointGroupIds>\\n</CreateCustomRoutingEndpointGroupsResponse>","errorExample":""}]', + 'title' => '批量创建自定义路由类型监听的终端节点组', + 'description' => '全球加速将根据监听路由类型定义的转发方式将流量分配到终端节点组内的终端节点上。'."\n" + ."\n" + .'- 配置智能路由类型监听后，全球加速实例可以根据延时因素（主要依赖于地理位置和网络链路情况）自动选择就近且健康的终端节点组进行流量转发，最终将客户端的网络访问请求送达至运行状况良好的终端节点。'."\n" + .'- 配置自定义路由类型监听后，全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围，以及终端节点（交换机vSwitch）的IP地址信息，生成端口映射表，从而确定性地将流量路由到交换机中特定IP地址和端口。'."\n" + ."\n" + .'本接口用于创建自定义路由类型监听的终端节点组。配置智能路由类型监听的终端节点组的API，请参见[CreateEndpointGroup](~~153259~~)。'."\n" + ."\n" + .'在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- **CreateCustomRoutingEndpointGroups**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听的终端节点组并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeCustomRoutingEndpointGroup](~~449373~~)或[ListCustomRoutingEndpointGroups](~~449374~~)查询自定义路由类型监听的终端节点组的状态： '."\n" + .' - 当存在终端节点组处于**init**状态时，表示终端节点组正在批量创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当所有终端节点组处于**active**状态时，表示终端节点组批量创建完成。'."\n" + .'- **CreateCustomRoutingEndpointGroups**接口不支持在同一个全球加速实例内并发创建自定义路由类型监听的终端节点组。'."\n" + ."\n" + .'### 前提条件'."\n" + .'创建自定义路由类型监听的终端节点组前，请确保您已完成以下操作：'."\n" + ."\n" + .'- 已创建标准型全球加速实例。具体操作，请参见[CreateAccelerator](~~206786~~)。'."\n" + .'- 已将带宽包与标准型全球加速实例绑定。具体操作，请参见[BandwidthPackageAddAccelerator](~~153239~~)。'."\n" + .'- 您已部署了相关应用，作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机（vSwitch）。'."\n" + .'- 您已经申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。创建自定义路由类型监听，请参见[CreateListener](~~153253~~)。', + ], + 'UpdateCustomRoutingEndpointGroupAttribute' => [ + 'summary' => '调用UpdateCustomRoutingEndpointGroupAttribute接口修改自定义路由类型监听关联的终端节点组名称和描述信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147875', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大256字符，不能包含`http://`和`https://`字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'EndpointGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCustomRoutingEndpointGroupAttributeResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateCustomRoutingEndpointGroupAttributeResponse>","errorExample":""}]', + 'title' => '修改自定义路由类型监听关联的终端节点组名称和描述信息', + ], + 'DescribeCustomRoutingEndpointGroup' => [ + 'summary' => '调用DescribeCustomRoutingEndpointGroup接口查询自定义路由类型监听关联的指定终端节点组配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaua****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '自定义路由类型监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaua****', + ], + 'Name' => [ + 'description' => '终端节点组名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Description' => [ + 'description' => '终端节点组的描述信息。', + 'type' => 'string', + 'example' => 'EndpointGroup', + ], + 'EndpointGroupIpList' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'string', + 'example' => '203.0.XX.XX', + ], + ], + 'EndpointGroupUnconfirmedIpList' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组出公网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'string', + 'example' => '203.0.XX.XX', + ], + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'State' => [ + 'description' => '终端节点组的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：正常。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'SlsRegion' => [ + 'description' => '在日志服务中创建的日志信息所属地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SlsProjectName' => [ + 'description' => '日志项目（Project）名称。', + 'type' => 'string', + 'example' => 'pn-01', + ], + 'SlsLogStoreName' => [ + 'description' => '日志库（Logstore）名称。', + 'type' => 'string', + 'example' => 'lsn-01', + ], + 'AccessLogSwitch' => [ + 'description' => '日志绑定状态。'."\n" + .'- **on**：已绑定。'."\n" + .'- **off**：未绑定。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。', + 'type' => 'string', + 'example' => 'on', + ], + 'EnableAccessLog' => [ + 'description' => '是否开启了访问日志。'."\n" + ."\n" + .'- **true**：已开启访问日志。'."\n" + ."\n" + .'- **false**：未开启访问日志。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'>- 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'>- 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaua****\\",\\n \\"Name\\": \\"group1\\",\\n \\"Description\\": \\"EndpointGroup\\",\\n \\"EndpointGroupIpList\\": [\\n \\"203.0.XX.XX\\"\\n ],\\n \\"EndpointGroupUnconfirmedIpList\\": [\\n \\"203.0.XX.XX\\"\\n ],\\n \\"EndpointGroupRegion\\": \\"cn-hangzhou\\",\\n \\"State\\": \\"active\\",\\n \\"SlsRegion\\": \\"cn-hangzhou\\",\\n \\"SlsProjectName\\": \\"pn-01\\",\\n \\"SlsLogStoreName\\": \\"lsn-01\\",\\n \\"AccessLogSwitch\\": \\"on\\",\\n \\"EnableAccessLog\\": true,\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomRoutingEndpointGroupResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaua****</EndpointGroupId>\\n <Name>group1</Name>\\n <Description>EndpointGroup</Description>\\n <EndpointGroupIpList>203.0.XX.XX</EndpointGroupIpList>\\n <EndpointGroupUnconfirmedIpList>203.0.XX.XX</EndpointGroupUnconfirmedIpList>\\n <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>\\n <State>active</State>\\n <SlsRegion>cn-hangzhou</SlsRegion>\\n <SlsProjectName>pn-01</SlsProjectName>\\n <SlsLogStoreName>lsn-01</SlsLogStoreName>\\n <AccessLogSwitch>on</AccessLogSwitch>\\n <EnableAccessLog>false</EnableAccessLog>\\n</DescribeCustomRoutingEndpointGroupResponse>","errorExample":""}]', + 'title' => '查询自定义路由类型监听关联的指定终端节点组配置信息', + ], + 'ListCustomRoutingEndpointGroups' => [ + 'summary' => '调用ListCustomRoutingEndpointGroups接口查询自定义路由类型监听关联的终端节点组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147622', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义路由类型监听ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'AccessLogSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启了访问日志。取值：'."\n" + ."\n" + .' **on**：已开启访问日志。'."\n" + ."\n" + .'该参数为空时，不进行筛选，返回所有终端节点组。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'enum' => [ + 'on', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndpointGroups' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组配置信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '自定义路由类型监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'Name' => [ + 'description' => '终端节点组的名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Description' => [ + 'description' => '终端节点组的描述信息。', + 'type' => 'string', + 'example' => 'EndpointGroup', + ], + 'EndpointGroupIpList' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组出公网IP列表。', + 'type' => 'string', + 'example' => '203.0.XX.XX', + ], + ], + 'EndpointGroupUnconfirmedIpList' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例升级后新增待确认的终端节点组IP列表。', + 'type' => 'string', + 'example' => '203.0.XX.XX', + ], + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'State' => [ + 'description' => '终端节点组的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：正常。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + ."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + ."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"EndpointGroups\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"Name\\": \\"group1\\",\\n \\"Description\\": \\"EndpointGroup\\",\\n \\"EndpointGroupIpList\\": [\\n \\"203.0.XX.XX\\"\\n ],\\n \\"EndpointGroupUnconfirmedIpList\\": [\\n \\"203.0.XX.XX\\"\\n ],\\n \\"EndpointGroupRegion\\": \\"cn-hangzhou\\",\\n \\"State\\": \\"active\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": true\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingEndpointGroupsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <EndpointGroups>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <Name>group1</Name>\\n <Description>EndpointGroup</Description>\\n <EndpointGroupIpList>203.0.XX.XX</EndpointGroupIpList>\\n <EndpointGroupUnconfirmedIpList>203.0.XX.XX</EndpointGroupUnconfirmedIpList>\\n <EndpointGroupRegion>cn-hangzhou</EndpointGroupRegion>\\n <State>active</State>\\n </EndpointGroups>\\n</ListCustomRoutingEndpointGroupsResponse>","errorExample":""}]', + 'title' => '查询自定义路由类型监听关联的终端节点组', + ], + 'DeleteCustomRoutingEndpointGroups' => [ + 'summary' => '调用DeleteCustomRoutingEndpointGroups接口批量删除自定义路由类型监听关联的终端节点组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146781', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除自定义路由类型监听的终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除自定义路由类型监听的终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'EndpointGroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待删除的终端节点组ID列表。'."\n" + ."\n" + .'您最多可输入10个终端节点组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除的终端节点组ID列表。'."\n" + ."\n" + .'您最多可输入10个终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp1dmlohjjz4kqaua****', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomRoutingEndpointGroupsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteCustomRoutingEndpointGroupsResponse>","errorExample":""}]', + 'title' => '批量删除自定义路由类型监听关联的终端节点组', + 'description' => '- **DeleteCustomRoutingEndpointGroups**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听的终端节点组并未删除完成，系统后台的删除任务仍在进行。您可以调用[DescribeCustomRoutingEndpointGroup](~~449373~~)查询自定义路由类型监听的终端节点组的状态：'."\n" + .' - 当终端节点组处于**deleting**状态时，表示终端节点组正在批量删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当查询不到要删除的终端节点组时，表示终端节点组批量删除完成。'."\n" + ."\n" + .'- **DeleteCustomRoutingEndpointGroups**接口不支持在同一个全球加速实例内并发删除自定义路由类型监听的终端节点组。', + ], + 'CreateCustomRoutingEndpointGroupDestinations' => [ + 'summary' => '调用CreateCustomRoutingEndpointGroupDestinations接口创建自定义路由监听所关联终端节点组的映射信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146833', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建终端节点组的映射信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建终端节点组的映射信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'DestinationConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'单次调用本接口最多可输入20个映射端口范围和协议类型信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'单次调用本接口最多可输入20个映射端口范围和协议类型信息。', + 'type' => 'object', + 'properties' => [ + 'Protocols' => [ + 'description' => '终端节点组后端服务协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + 'required' => true, + 'maxItems' => 2, + ], + 'FromPort' => [ + 'description' => '终端节点组后端服务起始端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'单次调用本接口最多可输入20条后端服务起始端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '终端节点组后端服务结束端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'单次调用本接口最多可输入20条后端服务结束端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'DestinationIds' => [ + 'description' => '终端节点组的映射信息配置ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的映射信息配置ID列表。', + 'type' => 'string', + 'example' => 'dst-abc123****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"DestinationIds\\": [\\n \\"dst-abc123****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomRoutingEndpointGroupDestinationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <DestinationIds>dst-abc123****</DestinationIds>\\n</CreateCustomRoutingEndpointGroupDestinationsResponse>","errorExample":""}]', + 'title' => '创建自定义路由监听所关联终端节点组的映射信息', + 'description' => '全球加速实例能够根据配置的监听端口范围、目标终端节点组的映射信息（协议和端口范围），以及终端节点（交换机vSwitch）的IP地址信息，生成端口映射表，从而确定性地将流量路由到交换机中特定IP地址和端口。'."\n" + ."\n" + .'本接口用于创建自定义路由监听所关联终端节点组的映射信息。在调用本接口时，请注意以下事项：'."\n" + .'- **CreateCustomRoutingEndpointGroupDestinations**接口属于异步接口，即系统会先返回一个请求ID，但终端节点组的映射信息并未创建完成，系统后台的创建任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询终端节点组的状态，来确认终端节点组的映射信息是否创建完成： '."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组的映射信息正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组的映射信息创建完成。'."\n" + .'- **CreateCustomRoutingEndpointGroupDestinations**接口不支持在同一个全球加速实例内并发创建自定义路由监听所关联终端节点组的映射信息。'."\n" + .'### 前提条件'."\n" + .'创建自定义路由监听所关联终端节点组的映射信息前，请确保您已完成以下操作：'."\n" + .'- 已创建标准型全球加速实例。具体操作，请参见[CreateAccelerator](~~206786~~)。'."\n" + .'- 已将带宽包与标准型全球加速实例绑定。具体操作，请参见[BandwidthPackageAddAccelerator](~~153239~~)。'."\n" + .'- 您已部署了相关应用，作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机（vSwitch）。'."\n" + .'- 您已经申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。创建自定义路由类型监听，请参见[CreateListener](~~153253~~)。'."\n" + .'- 您已创建了自定义路由类型监听的终端节点组。具体操作，请参见[CreateCustomRoutingEndpointGroups](~~449363~~)。', + ], + 'UpdateCustomRoutingEndpointGroupDestinations' => [ + 'summary' => '调用UpdateCustomRoutingEndpointGroupDestinations接口修改自定义路由类型监听所关联终端节点组的映射信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146981', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会修改终端节点组的映射信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改终端节点组的映射信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改映射信息的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'DestinationConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'单次调用本接口最多可输入20个映射端口范围和协议类型信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的映射信息配置。'."\n" + ."\n" + .'您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。'."\n" + ."\n" + .'单次调用本接口最多可输入20个映射端口范围和协议类型信息。', + 'type' => 'object', + 'properties' => [ + 'Protocols' => [ + 'description' => '终端节点组后端服务协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n\n" + .'每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务协议类型。取值：'."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n" + .'每个终端节点组映射端口范围和协议类型信息中，最多可以输入4个后端服务协议类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'required' => false, + 'maxItems' => 4, + ], + 'FromPort' => [ + 'description' => '终端节点组后端服务起始端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'单次调用本接口最多可输入20条后端服务起始端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '终端节点组后端服务结束端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n" + .'单次调用本接口最多可输入20条后端服务结束端口信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'DestinationId' => [ + 'description' => '终端节点组的映射信息配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dst-abc123****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateCustomRoutingEndpointGroupDestinationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateCustomRoutingEndpointGroupDestinationsResponse>","errorExample":""}]', + 'title' => '修改自定义路由类型监听所关联终端节点组的映射信息', + 'description' => '- **UpdateCustomRoutingEndpointGroupDestinations**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听所关联终端节点组的映射信息并未修改完成，系统后台的修改任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询自定义路由类型监听所关联终端节点组的状态，来确认终端节点组的映射信息是否修改完成。'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组的映射信息正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组的映射信息修改完成。'."\n" + .'- **UpdateCustomRoutingEndpointGroupDestinations**接口不支持在同一个全球加速实例内并发修改自定义路由类型监听所关联终端节点组的映射信息。', + ], + 'DescribeCustomRoutingEndpointGroupDestinations' => [ + 'summary' => '调用DescribeCustomRoutingEndpointGroupDestinations接口查询指定的终端节点组映射信息配置（自定义路由类型监听）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DestinationId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要查询的终端节点组映射信息配置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dst-123abc****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '映射信息配置所属终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp1j184jhb9i9ubwf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '终端节点组映射信息配置所属的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点组映射信息配置所属监听的ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'DestinationId' => [ + 'description' => '终端节点组映射信息配置ID。', + 'type' => 'string', + 'example' => 'dst-123abc****', + ], + 'Protocols' => [ + 'description' => '终端节点组后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + ], + 'FromPort' => [ + 'description' => '终端节点组后端服务起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '终端节点组后端服务结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'State' => [ + 'description' => '终端节点组映射信息配置的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：正常。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"DestinationId\\": \\"dst-123abc****\\",\\n \\"Protocols\\": [\\n \\"TCP\\"\\n ],\\n \\"FromPort\\": 80,\\n \\"ToPort\\": 80,\\n \\"State\\": \\"active\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomRoutingEndpointGroupDestinationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <DestinationId>dst-123abc****</DestinationId>\\n <Protocols>TCP</Protocols>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n <State>active</State>\\n</DescribeCustomRoutingEndpointGroupDestinationsResponse>","errorExample":""}]', + 'title' => '查询指定的终端节点组映射信息配置', + ], + 'ListCustomRoutingEndpointGroupDestinations' => [ + 'summary' => '调用ListCustomRoutingEndpointGroupDestinations接口查询终端节点组的映射信息配置列表（自定义路由类型监听）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147631', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点组映射信息配置的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点组映射信息配置的监听ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询映射信息配置的终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + ], + [ + 'name' => 'Protocols', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组后端服务的协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n" + .'为空时查询所有协议类型。'."\n" + ."\n" + .'您最多可输入10个协议信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务的协议类型。取值：'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。'."\n" + ."\n" + .'输入为空时，查询所有协议类型。'."\n" + ."\n" + .'您最多可输入10个协议信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'FromPort', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组后端服务起始端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'ToPort', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组后端服务结束端口。'."\n" + ."\n" + .'取值范围：**1**~**65499**，且需满足**FromPort**≤**ToPort**，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Destinations' => [ + 'description' => '终端节点组的映射信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组的映射信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '终端节点组映射信息配置所属的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点组映射信息配置所属的监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '映射信息配置所属的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'DestinationId' => [ + 'description' => '终端关节点组映射信息配置ID。', + 'type' => 'string', + 'example' => 'dst-123abc****', + ], + 'Protocols' => [ + 'description' => '终端节点组后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。'."\n" + ."\n" + .'- **TCP,UDP**：TCP和UDP协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + ], + 'FromPort' => [ + 'description' => '终端节点组后端服务起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '终端节点组后端服务结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值： '."\n" + ."\n" + .'- true：是托管实例。 '."\n" + ."\n" + .'- false：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Create', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Destinations\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"DestinationId\\": \\"dst-123abc****\\",\\n \\"Protocols\\": [\\n \\"TCP\\"\\n ],\\n \\"FromPort\\": 80,\\n \\"ToPort\\": 80,\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Create\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingEndpointGroupDestinationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Destinations>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <DestinationId>dst-123abc****</DestinationId>\\n <Protocols>TCP</Protocols>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n </Destinations>\\n</ListCustomRoutingEndpointGroupDestinationsResponse>","errorExample":""}]', + 'title' => '查询终端节点组的映射信息配置列表', + ], + 'DeleteCustomRoutingEndpointGroupDestinations' => [ + 'summary' => '调用DeleteCustomRoutingEndpointGroupDestinations接口删除自定义路由类型监听所关联终端节点组的映射信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146983', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除终端节点组的映射信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除终端节点组的映射信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除映射信息的终端节点组ID。'."\n" + ."\n" + .'> 该参数必选。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'DestinationIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点组的映射信息配置ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定待删除的终端节点组映射信息配置ID。'."\n" + ."\n" + .'输入为空时，表示删除当前**EndpointGroupId**下所有映射信息配置。'."\n" + ."\n" + .'您最多可输入100个终端节点组映射信息配置ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dst-abc123****', + ], + 'required' => false, + 'maxItems' => 4000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomRoutingEndpointGroupDestinationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteCustomRoutingEndpointGroupDestinationsResponse>","errorExample":""}]', + 'title' => '删除自定义路由类型监听所关联终端节点组的映射信息', + 'description' => '- **DeleteCustomRoutingEndpointGroupDestinations**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听所关联终端节点组的映射信息并未删除完成，系统后台的删除任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)查询自定义路由类型监听的终端节点组的状态，来确认终端节点组映射信息是否完成删除。'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点组的映射信息正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态，且通过[DescribeCustomRoutingEndpointGroupDestinations](~~449378~~)查询不到要删除的终端节点组映射信息时，表示终端节点组的映射信息删除完成。'."\n" + ."\n" + .'- **DeleteCustomRoutingEndpointGroupDestinations**接口不支持在同一个全球加速实例内并发删除自定义路由类型监听所关联终端节点组的映射信息。', + ], + 'CreateCustomRoutingEndpoints' => [ + 'summary' => '调用CreateCustomRoutingEndpoints接口创建自定义路由类型监听的终端节点。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146857', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待创建终端节点的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1bpn0kn908w4nb****', + ], + ], + [ + 'name' => 'EndpointConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'您最多可输入20个终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'您最多可输入20个终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '终端节点后端服务类型。取值：'."\n" + ."\n" + .' **PrivateSubNet**（默认值）：私网CIDR。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateSubNet', + ], + 'Endpoint' => [ + 'description' => '终端节点交换机（vSwitch）实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-test01', + ], + 'TrafficToEndpointPolicy' => [ + 'description' => '后端服务流量通行策略，取值：'."\n" + .'- **DenyAll**（默认值）：拒绝所有访问流量访问指定后端服务。'."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。'."\n" + .'您需要指定该通信目标的IP地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。', + 'type' => 'string', + 'required' => false, + 'example' => 'DenyAll', + ], + 'PolicyConfigurations' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => true, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EndpointIds' => [ + 'description' => '终端节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点ID列表。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EndpointIds\\": [\\n \\"epg-bp1dmlohjjz4kqaun****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomRoutingEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EndpointIds>epg-bp1dmlohjjz4kqaun****</EndpointIds>\\n</CreateCustomRoutingEndpointsResponse>","errorExample":""}]', + 'title' => '创建自定义路由类型监听的终端节点', + 'description' => '配置自定义路由类型监听后，全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围，以及终端节点（交换机vSwitch）的IP地址信息，生成端口映射表，从而确定性地将流量路由到交换机中特定IP地址和端口。'."\n" + ."\n" + .'本接口用于创建自定义路由类型监听的终端节点。在调用本接口时，请注意以下事项：'."\n" + ."\n" + .'- **CreateCustomRoutingEndpoints**接口属于异步接口，即系统会先返回一个请求ID，但终端节点并未创建完成，系统后台的创建任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询终端节点组的状态，来确认终端节点是否创建完成： '."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点创建完成。'."\n" + .'- **CreateCustomRoutingEndpoints**接口不支持在同一个全球加速实例内并发创建自定义路由监听的终端节点。'."\n" + .'### 前提条件'."\n" + .'创建自定义路由类型监听的终端节点前，请确保您已完成以下操作：'."\n" + .'- 已创建标准型全球加速实例。具体操作，请参见[CreateAccelerator](~~206786~~)。'."\n" + .'- 已将带宽包与标准型全球加速实例绑定。具体操作，请参见[BandwidthPackageAddAccelerator](~~153239~~)。'."\n" + .'- 已部署了相关应用，作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机（vSwitch）。'."\n" + .'- 已申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。创建自定义路由类型监听，请参见[CreateListener](~~153253~~)。'."\n" + .'- 已创建自定义路由类型监听的终端节点组。具体操作，请参见[CreateCustomRoutingEndpointGroups](~~449363~~)。', + ], + 'UpdateCustomRoutingEndpoints' => [ + 'summary' => '调用UpdateCustomRoutingEndpoints接口修改自定义路由类型监听的终端节点。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146862', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改终端节点的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1bpn0kn908w4nb****', + ], + ], + [ + 'name' => 'EndpointConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'您最多可输入20个终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点信息。'."\n" + ."\n" + .'您最多可输入20个终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'TrafficToEndpointPolicy' => [ + 'description' => '后端服务流量通行策略，取值：'."\n" + .'- **DenyAll**（默认值）：拒绝所有访问流量访问指定后端服务。'."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。'."\n" + .'您需要指定该通信目标的IP地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'您最多可输入20个后端服务流量通行策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'DenyAll', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。'."\n" + ."\n" + .'您最多可输入20个终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp1dmlohjjz4kqaun****', + ], + 'PolicyConfigurations' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个起始端口。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个结束端口。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EndpointIds' => [ + 'description' => '终端节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点ID列表。', + 'type' => 'string', + 'example' => 'ep-bp1dmlohjjz4kqaun****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EndpointIds\\": [\\n \\"ep-bp1dmlohjjz4kqaun****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateCustomRoutingEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EndpointIds>ep-bp1dmlohjjz4kqaun****</EndpointIds>\\n</UpdateCustomRoutingEndpointsResponse>","errorExample":""}]', + 'title' => '修改自定义路由类型监听的终端节点', + 'description' => '- **UpdateCustomRoutingEndpoints**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听的终端节点并未修改完成，系统后台的修改任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询自定义路由类型监听关联的终端节点组的状态，来确认自定义路由类型监听关联的终端节点组中的终端节点是否修改完成。'."\n" + .' - 当自定义路由类型监听关联的终端节点组处于**updating**状态时，表示自定义路由类型监听的终端节点正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当自定义路由类型监听关联的终端节点组处于**active**状态时，表示自定义路由类型监听的终端节点修改完成。'."\n" + .'- **UpdateCustomRoutingEndpoints**接口不支持在同一个全球加速实例内并发修改自定义路由类型监听的终端节点。', + ], + 'DescribeCustomRoutingEndpoint' => [ + 'summary' => '调用DescribeCustomRoutingEndpoint接口查询自定义终端节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'EndpointGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点所属终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp1j184jhb9i9ubwf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'String 04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '终端节点所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点所属监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点所属终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp1dmlohjjz4kqaun****', + ], + 'Type' => [ + 'description' => '终端节点后端服务类型。'."\n" + ."\n" + .' **PrivateSubNet**：私网CIDR。', + 'type' => 'string', + 'example' => 'PrivateSubNet', + ], + 'Endpoint' => [ + 'description' => '终端节点交换机（vSwitch）实例名称。', + 'type' => 'string', + 'example' => 'vsw-test01', + ], + 'TrafficToEndpointPolicy' => [ + 'description' => '后端服务流量通行策略。'."\n" + ."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **DenyAll**：拒绝所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。', + 'type' => 'string', + 'example' => 'DenyAll', + ], + 'State' => [ + 'description' => '终端节点当前状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"String\\\\t04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointId\\": \\"ep-bp1dmlohjjz4kqaun****\\",\\n \\"Type\\": \\"PrivateSubNet\\",\\n \\"Endpoint\\": \\"vsw-test01\\",\\n \\"TrafficToEndpointPolicy\\": \\"DenyAll\\",\\n \\"State\\": \\"active\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomRoutingEndpointResponse>\\n <RequestId>String\\t04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <EndpointId>ep-bp1dmlohjjz4kqaun****</EndpointId>\\n <Type>PrivateSubNet</Type>\\n <Endpoint>vsw-test01</Endpoint>\\n <TrafficToEndpointPolicy>DenyAll</TrafficToEndpointPolicy>\\n</DescribeCustomRoutingEndpointResponse>","errorExample":""}]', + 'title' => '查询自定义终端节点', + ], + 'ListCustomRoutingEndpoints' => [ + 'summary' => '查询终端节点配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147625', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点列表的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点列表的监听ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询终端节点列表的终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Endpoints' => [ + 'description' => '终端节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '终端节点所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点所属监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点所属终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'Type' => [ + 'description' => '终端节点后端服务类型。'."\n" + ."\n" + .' **PrivateSubNet**：私网CIDR。', + 'type' => 'string', + 'example' => 'PrivateSubNet', + ], + 'Endpoint' => [ + 'description' => '终端节点交换机（vSwitch）实例名称。', + 'type' => 'string', + 'example' => 'vsw-test01', + ], + 'TrafficToEndpointPolicy' => [ + 'description' => '后端服务流量通行策略。'."\n" + ."\n" + .'- **AllowAll**：允许所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **DenyAll**：拒绝所有访问流量访问指定后端服务。'."\n" + ."\n" + .'- **AllowCustom**：指定可以接收访问流量的通行目标。', + 'type' => 'string', + 'example' => 'DenyAll', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户可在该托管实例执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Endpoints\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp16jdc00bhe97sr5****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"Type\\": \\"PrivateSubNet\\",\\n \\"Endpoint\\": \\"vsw-test01\\",\\n \\"TrafficToEndpointPolicy\\": \\"DenyAll\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>10</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Endpoints>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp16jdc00bhe97sr5****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <Type>PrivateSubNet</Type>\\n <Endpoint>vsw-test01</Endpoint>\\n <TrafficToEndpointPolicy>DenyAll</TrafficToEndpointPolicy>\\n </Endpoints>\\n</ListCustomRoutingEndpointsResponse>","errorExample":""}]', + 'title' => '查询自定义终端节点列表', + ], + 'DeleteCustomRoutingEndpoints' => [ + 'summary' => '调用DeleteCustomRoutingEndpoints接口删除自定义路由类型监听的终端节点。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '146953', + 'abilityTreeNodes' => [ + 'FEATUREgaNBCRGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除终端节点的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1bpn0kn908w4nb****', + ], + ], + [ + 'name' => 'EndpointIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待删除的终端节点ID列表。'."\n" + ."\n" + .'输入为空时，删除当前终端节点组下所有的终端节点。'."\n" + ."\n" + .'您最多可以输入10个终端节点ID。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除的终端节点ID列表。'."\n" + ."\n" + .'输入为空时，删除当前终端节点组下所有的终端节点。'."\n" + ."\n" + .'您最多可以输入10个终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp1dmlohjjz4kqaun****', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomRoutingEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteCustomRoutingEndpointsResponse>","errorExample":""}]', + 'title' => '删除自定义路由类型监听的终端节点', + 'description' => '- **DeleteCustomRoutingEndpoints**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听的终端节点并未删除完成，系统后台的删除任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)查询自定义路由类型监听的终端节点组的状态，来确认终端节点是否完成删除。'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态，且通过[DescribeCustomRoutingEndpoint](~~449386~~)查询不到要删除的终端节点时，表示终端节点删除完成。'."\n" + .'- **DeleteCustomRoutingEndpoints**接口不支持在同一个全球加速实例内并发删除自定义路由类型监听的终端节点。', + ], + 'CreateCustomRoutingEndpointTrafficPolicies' => [ + 'summary' => '调用CreateCustomRoutingEndpointTrafficPolicies接口创建终端节点流量通行目标（自定义路由类型监听）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146955', + 'abilityTreeNodes' => [ + 'FEATUREgaYJ70J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待创建流量通行目标的终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-2zewuzypq5e6r3pfh****', + ], + ], + [ + 'name' => 'PolicyConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标IP地址。'."\n" + ."\n" + .'>该参数为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'每个终端节点下，最多可输入20个通行目标的端口范围，每个通行目标最多可输入20个端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'起始端口和结束端口输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**取值为**AllowCustom**时，该项生效。'."\n" + ."\n" + .'起始端口和结束端口输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PolicyIds' => [ + 'description' => '流量通行目标ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标ID列表。', + 'type' => 'string', + 'example' => 'ply-bptest2****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PolicyIds\\": [\\n \\"ply-bptest2****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateCustomRoutingEndpointTrafficPoliciesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <PolicyIds>ply-bptest2****</PolicyIds>\\n</CreateCustomRoutingEndpointTrafficPoliciesResponse>","errorExample":""}]', + 'title' => '创建终端节点流量通行目标', + 'description' => '该接口仅在终端节点的后端服务流量通行策略为指定可以接收访问流量的通行目标时有效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。即当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该接口有效。'."\n" + ."\n" + .'在调用本接口时，请注意以下事项：'."\n" + .'- **CreateCustomRoutingEndpointTrafficPolicies**接口属于异步接口，即系统会先返回一个请求ID，但自定义路由类型监听的终端节点流量通行目标并未创建完成，系统后台的创建任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询终端节点组的状态，来确认终端节点流量通行目标是否创建完成。 '."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点流量通行目标正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点流量通行目标创建完成。'."\n" + .'- **CreateCustomRoutingEndpointTrafficPolicies**接口不支持在同一个全球加速实例内并发创建终端节点流量通行目标。'."\n" + .'### 前提条件'."\n" + .'创建终端节点流量通行目标前，请确保您已完成以下操作：'."\n" + ."\n" + .'- 已创建标准型全球加速实例。具体操作，请参见[CreateAccelerator](~~206786~~)。'."\n" + ."\n" + .'- 标准型全球加速实例的带宽计费方式为**按带宽**时，已将带宽包与标准型全球加速实例绑定。具体操作，请参见[BandwidthPackageAddAccelerator](~~153239~~)。'."\n" + ."\n" + .'- 您已部署了相关应用，作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机（vSwitch）。'."\n" + ."\n" + .'- 您已经申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。创建自定义路由类型监听，请参见[CreateListener](~~153253~~)。'."\n" + .'- 您已创建了自定义路由类型监听的终端节点组。具体操作，请参见[CreateCustomRoutingEndpointGroups](~~449363~~)。'."\n" + ."\n" + .'- 您已创建了自定义路由类型监听的终端节点。具体操作，请参见[CreateCustomRoutingEndpoints](~~449382~~)。', + ], + 'UpdateCustomRoutingEndpointTrafficPolicies' => [ + 'summary' => '调用UpdateCustomRoutingEndpointTrafficPolicies接口修改终端节点流量通行目标（自定义路由类型监听）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146967', + 'abilityTreeNodes' => [ + 'FEATUREgaYJ70J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改流量通行目标的终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-2zewuzypq5e6r3pfh****', + ], + ], + [ + 'name' => 'PolicyConfigurations', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标配置。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '待修改的流量通行目标ID。'."\n" + ."\n" + .'> 该参数为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ply-bptest2****', + ], + 'Address' => [ + 'description' => '指定可以接受访问流量的通行目标IP地址。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该项生效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标IP地址。'."\n" + ."\n" + .'> 该参数为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该项生效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该项生效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该项生效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。'."\n" + ."\n" + .'起始端口和结束端口输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。'."\n" + ."\n" + .'仅当**TrafficToEndpointPolicy**（后端服务流量通行策略）取值为**AllowCustom**（指定可以接收访问流量的通行目标）时，该项生效。您可以通过[DescribeCustomRoutingEndpoint](~~449386~~)查询指定终端节点的后端服务流量通行策略。'."\n" + ."\n" + .'起始端口和结束端口输入为空时，表示支持该通行目标的所有端口。'."\n" + ."\n" + .'每个终端节点下，最多可输入500个通行目标的端口范围，每个通行目标最多可输入10个结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PolicyIds' => [ + 'description' => '流量通行目标ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标ID列表。', + 'type' => 'string', + 'example' => 'ply-bptest2****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPoints', + 'errorMessage' => 'endpoint %s not exist.', + ], + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'endpoint group %s is not exist', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'endpoint group state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PolicyIds\\": [\\n \\"ply-bptest2****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateCustomRoutingEndpointTrafficPoliciesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <PolicyIds>ply-bptest2****</PolicyIds>\\n</UpdateCustomRoutingEndpointTrafficPoliciesResponse>","errorExample":""}]', + 'title' => '修改终端节点流量通行目标', + 'description' => '- **UpdateCustomRoutingEndpointTrafficPolicies**接口属于异步接口，即系统会先返回一个请求ID，但终端节点流量通行目标并未修改完成，系统后台的修改任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)接口查询自定义路由类型监听关联的终端节点组的状态，来确认终端节点流量通行目标是否修改完成。'."\n" + .' - 当自定义路由类型监听关联的终端节点组处于**updating**状态时，表示终端节点流量通行目标正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当自定义路由类型监听关联的终端节点组处于**active**状态时，表示终端节点流量通行目标修改完成。'."\n" + .'- **UpdateCustomRoutingEndpointTrafficPolicies**接口不支持在同一个全球加速实例内并发修改终端节点流量通行目标。', + ], + 'DescribeCustomRoutingEndPointTrafficPolicy' => [ + 'summary' => '调用DescribeCustomRoutingEndPointTrafficPolicy接口查询指定终端节点流量通行目标。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的流量通行目标ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ply-bptest2****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询流量通行目标的终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp1d2utp8qqe2a44t****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '终端节点所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点所属监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点所属终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1bpn0kn908w4nb****', + ], + 'EndpointId' => [ + 'description' => '流量通行目标所属终端节点ID。', + 'type' => 'string', + 'example' => 'ep-2zewuzypq5e6r3pfh****', + ], + 'Endpoint' => [ + 'description' => '流量通行目标所属终端节点交换机（vSwitch）实例的名称。', + 'type' => 'string', + 'example' => 'vsw-test01', + ], + 'PolicyId' => [ + 'description' => '流量通行目标ID。', + 'type' => 'string', + 'example' => 'ply-bptest2****', + ], + 'Address' => [ + 'description' => '流量通行目标IP地址。', + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '流量通行目标端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标处理请求的端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '流量通行目标处理请求的起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '流量通行目标处理请求的结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + 'State' => [ + 'description' => '流量通行目标的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：正常。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + .'- **Listener**：监听资源。'."\n" + .'- **IpSet**：加速地域资源。'."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + .'- **Endpoint**：终端节点资源。'."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + .'> 仅在**Action**参数为**CreateChild**时有效', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp1bpn0kn908w4nb****\\",\\n \\"EndpointId\\": \\"ep-2zewuzypq5e6r3pfh****\\",\\n \\"Endpoint\\": \\"vsw-test01\\",\\n \\"PolicyId\\": \\"ply-bptest2****\\",\\n \\"Address\\": \\"10.0.XX.XX\\",\\n \\"PortRanges\\": [\\n {\\n \\"FromPort\\": 80,\\n \\"ToPort\\": 80\\n }\\n ],\\n \\"State\\": \\"active\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomRoutingEndPointTrafficPolicyResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp1bpn0kn908w4nb****</EndpointGroupId>\\n <EndpointId>ep-2zewuzypq5e6r3pfh****</EndpointId>\\n <Endpoint>vsw-test01</Endpoint>\\n <PolicyId>ply-bptest2****</PolicyId>\\n <Address>10.0.XX.XX</Address>\\n <PortRanges>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n </PortRanges>\\n</DescribeCustomRoutingEndPointTrafficPolicyResponse>","errorExample":""}]', + 'title' => '查询指定终端节点流量通行目标', + ], + 'ListCustomRoutingEndpointTrafficPolicies' => [ + 'summary' => '调用ListCustomRoutingEndpointTrafficPolicies接口查询终端节点流量通行目标列表（自定义路由类型监听）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147629', + 'abilityTreeNodes' => [ + 'FEATUREgaYJ70J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询流量通行目标列表的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询流量通行目标列表的监听ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询流量通行目标列表的终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询流量通行目标列表的终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp16jdc00bhe97sr5****', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '流量通行目标IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Policies' => [ + 'description' => '流量通行目标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '终端节点所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '终端节点所属自定义路由类型监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点所属终端节点组ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointId' => [ + 'description' => '流量通行目标所属终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'PolicyId' => [ + 'description' => '流量通行目标ID。', + 'type' => 'string', + 'example' => 'ply-bp1dmlohjjz4kqaun****', + ], + 'Address' => [ + 'description' => '流量通行目标IP地址。', + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'PortRanges' => [ + 'description' => '流量通行目标端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标端口范围。', + 'type' => 'object', + 'properties' => [ + 'FromPort' => [ + 'description' => '流量通行目标处理请求的起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ToPort' => [ + 'description' => '流量通行目标处理请求的结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> - 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + ."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + ."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Policies\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"PolicyId\\": \\"ply-bp1dmlohjjz4kqaun****\\",\\n \\"Address\\": \\"10.0.XX.XX\\",\\n \\"PortRanges\\": [\\n {\\n \\"FromPort\\": 80,\\n \\"ToPort\\": 80\\n }\\n ],\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingEndpointTrafficPoliciesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Policies>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>lsr-bp1bpn0kn908w4nbw****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <PolicyId>ply-bp1dmlohjjz4kqaun****</PolicyId>\\n <Address>10.0.XX.XX</Address>\\n <PortRanges>\\n <FromPort>80</FromPort>\\n <ToPort>80</ToPort>\\n </PortRanges>\\n </Policies>\\n</ListCustomRoutingEndpointTrafficPoliciesResponse>","errorExample":""}]', + 'title' => '查询终端节点流量通行目标列表', + ], + 'DeleteCustomRoutingEndpointTrafficPolicies' => [ + 'summary' => '调用DeleteCustomRoutingEndpointTrafficPolicies接口删除终端节点流量通行目标。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146971', + 'abilityTreeNodes' => [ + 'FEATUREgaYJ70J9', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除流量通行目标的终端节点ID。'."\n" + ."\n" + .'> 该参数为必选。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-2zewuzypq5e6r3pfh****', + ], + ], + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '流量通行目标ID列表。'."\n" + ."\n" + .'您最多可输入9000个流量通行目标ID。', + 'type' => 'array', + 'items' => [ + 'description' => '流量通行目标ID列表。'."\n" + ."\n" + .'您最多可输入9000个流量通行目标ID。'."\n" + ."\n" + .'> 该参数为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'ply-bptest2****', + ], + 'required' => true, + 'maxItems' => 9000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPoints', + 'errorMessage' => 'endpoint %s not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomRoutingEndpointTrafficPoliciesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteCustomRoutingEndpointTrafficPoliciesResponse>","errorExample":""}]', + 'title' => '删除终端节点流量通行目标', + 'description' => '- **DeleteCustomRoutingEndpointTrafficPolicies**接口属于异步接口，即系统会先返回一个请求ID，但终端节点流量通行目标并未删除完成，系统后台的删除任务仍在进行。您可以通过调用[DescribeCustomRoutingEndpointGroup](~~449373~~)查询自定义路由类型监听的终端节点组的状态，来确认终端节点流量通行目标是否完成删除。'."\n" + .' - 当终端节点组处于**updating**状态时，表示终端节点流量通行目标正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态，且通过[DescribeCustomRoutingEndPointTrafficPolicy](~~449392~~)查询不到要删除的终端节点流量通行目标时，表示终端节点流量通行目标删除完成。'."\n" + ."\n" + .'- **DeleteCustomRoutingEndpointTrafficPolicies**接口不支持在同一个全球加速实例内并发删除终端节点流量通行目标。', + ], + 'ListCustomRoutingPortMappings' => [ + 'summary' => '调用ListCustomRoutingPortMappings接口查询生成的端口映射表（自定义路由类型监听）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147538', + 'abilityTreeNodes' => [ + 'FEATUREga3XB3RZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询端口映射表的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询端口映射表的监听ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询端口映射表的终端节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'epg-bp16jdc00bhe97sr5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PortMappings' => [ + 'description' => '端口映射表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射表信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '端口映射表所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '端口映射表所属自定义路由类型监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属地域ID。', + 'type' => 'string', + 'example' => 'us-west-1', + ], + 'Vswitch' => [ + 'description' => '终端节点交换机（vSwitch）实例名称。', + 'type' => 'string', + 'example' => 'vsw-test01', + ], + 'AcceleratorPort' => [ + 'description' => '加速端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'Protocols' => [ + 'description' => '后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。', + 'type' => 'array', + 'items' => [ + 'description' => '后端服务协议类型。'."\n" + ."\n" + .'- **TCP**：TCP协议。'."\n" + ."\n" + .'- **UDP**：UDP协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + ], + 'DestinationTrafficState' => [ + 'description' => '后端实例流量通行策略。'."\n" + ."\n" + .'- **allow**：允许后端实例接收流量。'."\n" + ."\n" + .'- **deny**：不允许后端实例接收流量。', + 'type' => 'string', + 'example' => 'allow', + ], + 'DestinationSocketAddress' => [ + 'description' => '后端实例服务IP地址与端口信息。', + 'type' => 'object', + 'properties' => [ + 'IpAddress' => [ + 'description' => '后端实例服务IP地址。', + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'Port' => [ + 'description' => '后端实例服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PortMappings\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointGroupRegion\\": \\"us-west-1\\",\\n \\"Vswitch\\": \\"vsw-test01\\",\\n \\"AcceleratorPort\\": 3000,\\n \\"Protocols\\": [\\n \\"TCP\\"\\n ],\\n \\"DestinationTrafficState\\": \\"allow\\",\\n \\"DestinationSocketAddress\\": {\\n \\"IpAddress\\": \\"10.0.XX.XX\\",\\n \\"Port\\": 443\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingPortMappingsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <PortMappings>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <EndpointGroupRegion>us-west-1</EndpointGroupRegion>\\n <Vswitch>vsw-test01</Vswitch>\\n <AcceleratorPort>3000</AcceleratorPort>\\n <Protocols>TCP</Protocols>\\n <DestinationTrafficState>allow</DestinationTrafficState>\\n <DestinationSocketAddress>\\n <IpAddress>10.0.XX.XX</IpAddress>\\n <Port>443</Port>\\n </DestinationSocketAddress>\\n </PortMappings>\\n</ListCustomRoutingPortMappingsResponse>","errorExample":""}]', + 'title' => '查询生成的端口映射表', + 'description' => '配置自定义路由类型监听及终端节点组后，全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围，以及终端节点（交换机vSwitch）的IP地址信息，生成端口映射表。自定义路由类型监听可根据该端口映射表确定性地将流量路由到交换机中特定IP地址和端口。本接口用于查询生成的端口映射表。', + ], + 'ListCustomRoutingPortMappingsByDestination' => [ + 'summary' => '调用ListCustomRoutingPortMappingsByDestination接口查询指定后端实例的端口映射表（自定义路由类型监听）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147617', + 'abilityTreeNodes' => [ + 'FEATUREga3XB3RZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的条目数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询后端实例所属的终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp16jdc00bhe97sr5****', + ], + ], + [ + 'name' => 'DestinationAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询后端实例服务IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '10.0.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'String 04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PortMappings' => [ + 'description' => '端口映射表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '端口映射表信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '端口映射表所属全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '端口映射表所属自定义路由类型监听ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp14sz7ftcwwjgrdm****', + ], + 'EndpointId' => [ + 'description' => '终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属地域ID。', + 'type' => 'string', + 'example' => 'us-west-1', + ], + 'Vswitch' => [ + 'description' => '终端节点交换机（vSwitch）实例名称。', + 'type' => 'string', + 'example' => 'vsw-test01', + ], + 'AcceleratorPort' => [ + 'description' => '加速端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'Protocols' => [ + 'description' => '后端服务协议类型。'."\n" + .'- **TCP**：TCP协议。'."\n" + .'- **UDP**：UDP协议。', + 'type' => 'array', + 'items' => [ + 'description' => '后端服务协议类型。'."\n" + .'- **TCP**：TCP协议。'."\n" + .'- **UDP**：UDP协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + ], + 'DestinationTrafficState' => [ + 'description' => '后端实例流量通行策略。'."\n" + ."\n" + .'- **allow**：允许后端实例接收流量。'."\n" + ."\n" + .'- **deny**：不允许后端实例接收流量。', + 'type' => 'string', + 'example' => 'allow', + ], + 'DestinationSocketAddress' => [ + 'description' => '后端实例服务IP地址与端口信息。', + 'type' => 'object', + 'properties' => [ + 'IpAddress' => [ + 'description' => '后端实例服务IP地址。', + 'type' => 'string', + 'example' => '10.0.XX.XX', + ], + 'Port' => [ + 'description' => '后端实例服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"String\\\\t04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PortMappings\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"EndpointGroupId\\": \\"epg-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointGroupRegion\\": \\"us-west-1\\",\\n \\"Vswitch\\": \\"vsw-test01\\",\\n \\"AcceleratorPort\\": 3000,\\n \\"Protocols\\": [\\n \\"TCP\\"\\n ],\\n \\"DestinationTrafficState\\": \\"allow\\",\\n \\"DestinationSocketAddress\\": {\\n \\"IpAddress\\": \\"10.0.XX.XX\\",\\n \\"Port\\": 443\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCustomRoutingPortMappingsByDestinationResponse>\\n <RequestId>String\\t04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <PortMappings>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>ga-bp1odcab8tmno0hdq****</ListenerId>\\n <EndpointGroupId>epg-bp14sz7ftcwwjgrdm****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <EndpointGroupRegion>us-west-1</EndpointGroupRegion>\\n <Vswitch>vsw-test01</Vswitch>\\n <AcceleratorPort>3000</AcceleratorPort>\\n <Protocols>TCP</Protocols>\\n <DestinationTrafficState>allow</DestinationTrafficState>\\n <DestinationSocketAddress>\\n <IpAddress>10.0.XX.XX</IpAddress>\\n <Port>443</Port>\\n </DestinationSocketAddress>\\n </PortMappings>\\n</ListCustomRoutingPortMappingsByDestinationResponse>","errorExample":""}]', + 'title' => '查询指定后端实例的端口映射表', + ], + 'CreateForwardingRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8510', + 'abilityTreeNodes' => [ + 'FEATUREgaRQQP6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4q****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1s0vzbi5bxlx5****', + ], + ], + [ + 'name' => 'ForwardingRules', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '转发策略配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略配置信息。', + 'type' => 'object', + 'properties' => [ + 'Priority' => [ + 'description' => '转发策略优先级。'."\n" + .'取值范围：**1**~**10000**。值越小表示优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'RuleConditions' => [ + 'description' => '转发条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发条件列表。', + 'type' => 'object', + 'properties' => [ + 'RuleConditionType' => [ + 'description' => '转发条件类型。取值：'."\n" + .'- **Host**：域名。'."\n" + .'- **Path**：路径。'."\n" + .'- **RequestHeader**：HTTP标头。'."\n" + .'- **Query**：查询字符串。'."\n" + .'- **Method**：HTTP请求方法。'."\n" + .'- **Cookie**：Cookie。'."\n" + .'- **SourceIP**：源IP。', + 'type' => 'string', + 'required' => false, + 'example' => 'Host', + 'enum' => [ + 'Host', + 'Path', + 'Method', + 'RequestHeader', + 'Query', + 'Cookie', + 'SourceIP', + ], + ], + 'RuleConditionValue' => [ + 'description' => '转发条件类型对应的值。'."\n" + .'根据**RuleConditionType**传入不同的JSON字符串值。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Host**时，该参数为域名条件配置信息。一个转发策略内只允许创建一个域名类型转发规则，该转发规则内支持配置多个域名，多个域名间为“或”关系。域名长度为3~128个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（*）和半角问号（?）作为通配符。取值样例为`["www.example.com", "www.aliyun.com"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Path**时，该参数为路径条件配置信息。一个转发策略内允许创建多个路径类型转发规则，多个路径类型转发规则间为”或“关系，一个转发路径类型规则内支持配置多个路径，多个路径间为“或”关系。路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、撇号（\'），支持使用星号（*）和半角问号（?）作为通配符。取值样例为`["/a", "/b/"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**RequestHeader**时，该参数为HTTP标头字段条件配置信息，由键（Key）和值（Value）组成。同一个转发规则条件内标头字段值不能重复。取值样例为`[{"header1":["value1","value2"]}]`。'."\n" + ."\n" + .' - Key：HTTP标头的键值长度为1~40个字符，支持字母、数字、短划线（-）和下划线（_）。'."\n" + ."\n" + .' - Value：HTTP标头的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，开头和结尾不能为空格。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Query**时，该参数为查询字符串条件配置信息，由键（Key）和值（Value）组成。取值样例为`[{"query1":["value1"]}, {"query2":["value2"]}]`。'."\n" + .' - Key：HTTP标头的键值长度为1~100个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`[]{}<>\\;/?:@&=+,$%"^~`。'."\n" + ."\n" + .' - Value：HTTP标头的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`[]{}<>\\;/?:@&=+,$%"^~`。'."\n" + .'- 当**RuleConditionType**取值为**Method**时，该参数为请求方法配置信息。取值范围为**HEAD**、**GET**、**POST**、**OPTIONS**、**PUT**、**PATCH**、**DELETE**。取值样例为`["GET", "OPTIONS", "POST"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Cookie**时，该参数为Cookie配置信息，由键（Key）和值（Value）组成。取值样例为`[{"cookie1":["value1"]}, {"cookie2":["value2"]}]`'."\n" + .' - Key：Cookie的键值长度为1~100个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`#[]{}\\<>&`。'."\n" + ."\n" + .' - Value：Cookie的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`#[]{}\\<>&`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**SourceIP**时，该参数为源IP配置信息，支持IP地址，例如1.1.XX.XX/32，或IP地址段，例如2.2.XX.XX/24。一个转发规则只允许创建一个源IP规则，该转发规则内支持配置多个源IP，多个IP之间为“或”关系。取值样例为`["1.1.XX.XX/32", "2.2.XX.XX/24"]`。', + 'type' => 'string', + 'required' => false, + 'example' => '["www.example.com", "www.aliyun.com"]', + ], + 'PathConfig' => [ + 'description' => '路径配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '路径配置。'."\n" + ."\n" + .'路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、半角单引号（\'），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'array', + 'items' => [ + 'description' => '路径配置。'."\n" + ."\n" + .'路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、半角单引号（\'），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'HostConfig' => [ + 'description' => '域名配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '域名配置。'."\n" + ."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。域名长度为3~128个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + 'RuleActions' => [ + 'description' => '转发动作。', + 'type' => 'array', + 'items' => [ + 'description' => '转发动作。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => '转发优先级。'."\n" + ."\n" + .'> 当前无实际意义，无需配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'RuleActionType' => [ + 'description' => '转发动作类型。取值：'."\n" + ."\n" + .'- **ForwardGroup**：转发。'."\n" + .'- **Redirect**：重定向。'."\n" + .'- **FixResponse**：返回固定响应。'."\n" + .'- **Rewrite**：重写。'."\n" + .'- **AddHeader**：写入头字段。'."\n" + .'- **RemoveHeader**：删除头字段。'."\n" + .'- **Drop**：丢弃。', + 'type' => 'string', + 'required' => true, + 'example' => 'ForwardGroup', + ], + 'RuleActionValue' => [ + 'description' => '转发动作类型对应的值。'."\n" + ."\n" + .'根据**RuleActionType**传入不同的JSON字符串值。'."\n" + ."\n" + .'一个转发规则最多只能有一条**ForwardGroup**、**Redirect**、**FixResponse**类型的转发动作。**Rewrite**、**AddHeader**、**RemoveHeader**类型的转发动作顺序必须在**ForwardGroup**类型的转发动作之前。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**ForwardGroup**时，该参数为虚拟终端节点组信息。仅支持转发至一个虚拟终端节点组。取值样例为`{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}`，其中：'."\n" + ."\n" + .' - `type`：取值为`endpointgroup`。'."\n" + ."\n" + .' - `value`：目标虚拟终端节点组ID。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**Redirect**时，该参数为重定向配置信息。**Redirect**类型的转发动作中`protocol`、`domain`、`port`、`path`、`query`不能全部为空或者默认值。取值样例为`{"protocol":"HTTP", "domain":"www.example.com", "port":"80", "path":"/a","query":"value1", "code":"301" }`，其中：'."\n" + ."\n" + .' - `protocol`：要跳转的协议。取值范围为`${protocol}`（默认值）、`HTTP`、`HTTPS`。'."\n" + ."\n" + .' - `domain`：要跳转的域名。默认值为`${host}`（默认值），您还可以输入其他域名信息，域名长度为3~128个字符，只允许包含小写字母、数字和特殊字符`.-?=~_-+/^*!$&()[]`。'."\n" + ."\n" + .' - `port`：要跳转的端口。默认值为`${port}`，您还可以输入端口号，端口取值范围为1~63335。'."\n" + ."\n" + .' - `path`：要跳转的路径。默认值为`${path}`，路径长度限制为1~128个字符。正则表达式类型的路径，必须以波浪线（~）开头，支持的大小写字母、数字和特殊字符`.-_/=?~^*$:()[]+`；非正则表达式类型的路径，必须以正斜线（/） 开头，支持大小写字母、数字和特殊字符`.-_/=?:`。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。默认值为`${query}`，您还可以输入其他查询字符串信息，查询字符串长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和特殊字符`[]{}<>\\#&`。'."\n" + ."\n" + .' - `code`：跳转方式。支持`301`、`302`、`303`、`307`或`308`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**FixResponse**时，该参数为返回固定响应配置信息。取值样例为`{"code":"200", "type":"text/plain", "content":"dssacav" }`，其中：'."\n" + .' - `code`：响应状态码。仅支持`2xx`、`4xx`、`5xx`数字型字符串，`x`为任意数字。'."\n" + ."\n" + .' - `type`：响应正文类型。仅支持**text/plain**, **text/css**, **text/html**, **application/javascript**, **application/json**。'."\n" + ."\n" + .' - `content`：响应正文。响应正文长度不能超过1000个字符，不支持中文字符。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**AddHeader**时，该参数为插入HTTP标头字段配置信息。转发规则中存在**AddHeader**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。取值样例为`[{"name":"header1","type":"userdefined", "value":"value"}]`，其中：'."\n" + ."\n" + .' - `name`：HTTP标头字段名称。名称长度为1~40字符，支持大小写字母、数字、短划线（-）和下划线（_）。**AddHeader**中的HTTP标头字段名称不能重复，也不能和**RemoveHeader**中的HTTP标头字段名称重复。'."\n" + ."\n" + .' - `type`：HTTP标头字段内容类型。取值范围为`user-defined`（用户指定）、`ref`（引用）、`system-defined`（系统定义）。'."\n" + ."\n" + .' - `value`：HTTP标头字段内容，内容不能为空。`type`为`user-defined`（用户指定）时，长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内的可打印字符，支持大小写字母、数字、短划线（-）和下划线（_），开头和结尾不能为空格；`type`为`ref`（引用）时，长度为1~128个字符，支持大小写字母、数字、短划线（-）和下划线（_），开头和结尾不能为空格；`type`为`system-defined`（系统定义）时，仅支持取值为`ClientSrcIp`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**RemoveHeader**时，该参数为删除HTTP标头字段信息。转发规则中存在**RemoveHeader**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。长度为1~40字符，支持大小写字母、数字、短划线（-）和下划线（_）。取值样例为`["header1"]`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**Rewrite**时，该参数为重写配置信息。转发规则中存在**Rewrite**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。取值样例为`{"domain":"value1", "path":"value2", "query":"value3"}`，其中：'."\n" + ."\n" + .' - `domain`：要跳转的域名。默认值为`${host}`，您还可以输入其他域名信息，域名长度为3~128个字符，只允许包含小写字母、数字和特殊字符`.-?=~_-+/^*!$&()[]`。'."\n" + ."\n" + .' - `path`：要跳转的路径。默认值为`${path}`，路径长度限制为1~128个字符。正则表达式类型的路径，必须以波浪线（~）开头，支持的大小写字母、数字和特殊字符`.-_/=?~^*$:()[]+`；非正则表达式类型的路径，必须以正斜线（/） 开头，支持大小写字母、数字和特殊字符`.-_/=?:`。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。默认值为`${query}`，您还可以输入其他查询字符串信息，查询字符串长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和特殊字符`[]{}<>\\#&`。'."\n" + .'- 当**RuleActionType**取值为**Drop**时，该参数无需填写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"type":"endpointgroup","value":"epg-bp1l49ltx6iengvf2ks5z****"}]', + ], + 'ForwardGroupConfig' => [ + 'description' => '转发配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'object', + 'properties' => [ + 'ServerGroupTuples' => [ + 'description' => '终端节点组配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1nktp3qgbcq9ih6****', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + 'ForwardingRuleName' => [ + 'description' => '转发策略名称。长度为2~128个英文或中文字符，必须以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'RuleDirection' => [ + 'description' => '规则生效方向。无需配置。'."\n" + ."\n" + .'目前默认为**request**，表示请求方向生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'request', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'ForwardingRules' => [ + 'description' => '转发策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略信息。', + 'type' => 'object', + 'properties' => [ + 'ForwardingRuleId' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp1dii16gu9qdvb34****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'QuotaExceeded.ForwardingRule', + 'errorMessage' => 'The number of forwarding rule exceeds the limit.', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + [ + 'errorCode' => 'RepeatPathAndHost.ForwardingRule', + 'errorMessage' => 'The path and host %s are duplicated.', + ], + [ + 'errorCode' => 'QuotaExceeded.RuleConditionConfig', + 'errorMessage' => 'The number of paths and hosts exceeds the limit.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"ForwardingRules\\": [\\n {\\n \\"ForwardingRuleId\\": \\"frule-bp1dii16gu9qdvb34****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateForwardingRulesResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <ForwardingRules>\\n <ForwardingRuleId>frule-bp1dii16gu9qdvb34****</ForwardingRuleId>\\n </ForwardingRules>\\n</CreateForwardingRulesResponse>","errorExample":""}]', + 'title' => '创建转发规则', + 'summary' => '如果您的业务需要根据请求的属性（域名、路径等）或请求中包含的数据信息（HTTP标头、Cookie等）来进行流量分发和处理，您可以自定义监听的转发规则。监听会根据转发规则对访问请求执行不同的转发动作。您可以通过调用CreateForwardingRules接口创建转发规则。', + 'description' => '在您调用本接口创建转发规则前，建议您先了解转发规则原理及匹配规则。更多信息，请参见[转发策略](~~204224~~)。'."\n" + ."\n" + .'调用本接口时，请注意以下事项：'."\n" + ."\n\n" + .'- **CreateForwardingRules**接口属于异步接口，即系统会先返回一个转发策略ID，但转发策略并未创建完成，系统后台的创建任务仍在进行。您可以调用[ListForwardingRules](~~205817~~)查询转发策略的状态：'."\n" + ."\n" + .' - 当转发策略处于**configuring**状态时，表示转发策略正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当转发策略处于**active**状态时，表示转发策略创建完成。'."\n" + ."\n" + .'- **CreateForwardingRules**接口不支持在同一个全球加速实例内并发创建转发策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateForwardingRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8512', + 'abilityTreeNodes' => [ + 'FEATUREgaRQQP6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4q****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1s0vzbi5bxlx5****', + ], + ], + [ + 'name' => 'ForwardingRules', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '转发策略配置信息列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '转发策略配置信息列表。', + 'type' => 'object', + 'properties' => [ + 'Priority' => [ + 'description' => '转发策略优先级。取值范围：**1**~**10000**。值越小表示优先级越高。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1000', + ], + 'RuleConditions' => [ + 'description' => '转发条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发条件列表。', + 'type' => 'object', + 'properties' => [ + 'RuleConditionType' => [ + 'description' => '转发条件类型。取值：'."\n" + .'- **Host**：域名。'."\n" + .'- **Path**：路径。'."\n" + .'- **RequestHeader**：HTTP标头。'."\n" + .'- **Query**：查询字符串。'."\n" + .'- **Method**：HTTP请求方法。'."\n" + .'- **Cookie**：Cookie。'."\n" + .'- **SourceIP**：源IP。', + 'type' => 'string', + 'required' => true, + 'example' => 'Host', + ], + 'RuleConditionValue' => [ + 'description' => '转发条件类型对应的值。'."\n" + .'根据**RuleConditionType**传入不同的JSON字符串值。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Host**时，该参数为域名条件配置信息。一个转发策略内只允许创建一个域名类型转发规则，该转发规则内支持配置多个域名，多个域名间为“或”关系。域名长度为3~128个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（*）和半角问号（?）作为通配符。取值样例为`["www.example.com", "www.aliyun.com"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Path**时，该参数为路径条件配置信息。一个转发策略内允许创建多个路径类型转发规则，多个路径类型转发规则间为”或“关系，一个转发路径类型规则内支持配置多个路径，多个路径间为“或”关系。路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、撇号（\'），支持使用星号（*）和半角问号（?）作为通配符。取值样例为`["/a", "/b/"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**RequestHeader**时，该参数为HTTP标头字段条件配置信息，由键（Key）和值（Value）组成。同一个转发规则条件内标头字段值不能重复。取值样例为`[{"header1":["value1","value2"]}]`。'."\n" + ."\n" + .' - Key：HTTP标头的键值长度为1~40个字符，支持字母、数字、短划线（-）和下划线（_）。'."\n" + ."\n" + .' - Value：HTTP标头的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，开头和结尾不能为空格。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Query**时，该参数为查询字符串条件配置信息，由键（Key）和值（Value）组成。取值样例为`[{"query1":["value1"]}, {"query2":["value2"]}]`。'."\n" + .' - Key：HTTP标头的键值长度为1~100个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`[]{}<>\\;/?:@&=+,$%|"^~`。'."\n" + ."\n" + .' - Value：HTTP标头的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`[]{}<>\\;/?:@&=+,$%|"^~`。'."\n" + .'- 当**RuleConditionType**取值为**Method**时，该参数为请求方法配置信息。取值范围为**HEAD**、**GET**、**POST**、**OPTIONS**、**PUT**、**PATCH**、**DELETE**。取值样例为`["GET", "OPTIONS", "POST"]`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**Cookie**时，该参数为Cookie配置信息，由键（Key）和值（Value）组成。取值样例为`[{"cookie1":["value1"]}, {"cookie2":["value2"]}]`'."\n" + .' - Key：Cookie的键值长度为1~100个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`#[]{}\\|<>&`。'."\n" + ."\n" + .' - Value：Cookie的值长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和`#[]{}\\|<>&`。'."\n" + ."\n" + .'- 当**RuleConditionType**取值为**SourceIP**时，该参数为源IP配置信息，支持IP地址，例如1.1.XX.XX/32，或IP地址段，例如2.2.XX.XX/24。一个转发规则只允许创建一个源IP规则，该转发规则内支持配置多个源IP，多个IP之间为“或”关系。取值样例为`["1.1.XX.XX/32", "2.2.XX.XX/24"]`。', + 'type' => 'string', + 'required' => false, + 'example' => '["www.example.com", "www.aliyun.com"]', + ], + 'PathConfig' => [ + 'description' => '路径配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '路径配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'array', + 'items' => [ + 'description' => '路径配置。'."\n" + ."\n" + .'路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、半角单引号（\'），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'HostConfig' => [ + 'description' => '域名配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '域名配置信息。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleConditionType**和**RuleConditionValue**配置转发条件。', + 'type' => 'array', + 'items' => [ + 'description' => '域名配置。'."\n" + ."\n" + .'域名长度为3~128个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（*）和半角问号（?）作为通配符。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + 'RuleActions' => [ + 'description' => '转发动作。', + 'type' => 'array', + 'items' => [ + 'description' => '转发动作。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => '转发优先级。'."\n" + ."\n" + .'> 当前无实际意义，无需配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + 'RuleActionType' => [ + 'description' => '转发动作类型。取值：'."\n" + ."\n" + .'- **ForwardGroup**：转发。'."\n" + .'- **Redirect**：重定向。'."\n" + .'- **FixResponse**：返回固定响应。'."\n" + .'- **Rewrite**：重写。'."\n" + .'- **AddHeader**：写入头字段。'."\n" + .'- **RemoveHeader**：删除头字段。'."\n" + .'- **Drop**：丢弃。', + 'type' => 'string', + 'required' => true, + 'example' => 'ForwardGroup', + 'default' => 'ForwardGroup', + 'enum' => [ + 'ForwardGroup', + 'Redirect', + 'FixResponse', + 'AddHeader', + 'RemoveHeader', + 'Rewrite', + 'Drop', + 'ForwardGroupMirror', + ], + ], + 'RuleActionValue' => [ + 'description' => '转发动作类型对应的值。'."\n" + ."\n" + .'根据**RuleActionType**传入不同的JSON字符串值。'."\n" + ."\n" + .'一个转发规则最多只能有一条**ForwardGroup**、**Redirect**、**FixResponse**类型的转发动作。**Rewrite**、**AddHeader**、**RemoveHeader**类型的转发动作顺序必须在**ForwardGroup**类型的转发动作之前。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**ForwardGroup**时，该参数为虚拟终端节点组信息。仅支持转发至一个虚拟终端节点组。取值样例为`{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}`，其中：'."\n" + ."\n" + .' - `type`：取值为`endpointgroup`。'."\n" + ."\n" + .' - `value`：目标虚拟终端节点组ID。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**Redirect**时，该参数为重定向配置信息。**Redirect**类型的转发动作中`protocol`、`domain`、`port`、`path`、`query`不能全部为空或者默认值。取值样例为`{"protocol":"HTTP", "domain":"www.example.com", "port":"80", "path":"/a","query":"value1", "code":"301" }`，其中：'."\n" + ."\n" + .' - `protocol`：要跳转的协议。取值范围为`${protocol}`（默认值）、`HTTP`、`HTTPS`。'."\n" + ."\n" + .' - `domain`：要跳转的域名。默认值为`${host}`（默认值），您还可以输入其他域名信息，域名长度为3~128个字符，只允许包含小写字母、数字和特殊字符`.-?=~_-+/^*!$&|()[]`。'."\n" + ."\n" + .' - `port`：要跳转的端口。默认值为`${port}`，您还可以输入端口号，端口取值范围为1~63335。'."\n" + ."\n" + .' - `path`：要跳转的路径。默认值为`${path}`，路径长度限制为1~128个字符。正则表达式类型的路径，必须以波浪线（~）开头，支持的大小写字母、数字和特殊字符`.-_/=?~^*$:()[]+|`；非正则表达式类型的路径，必须以正斜线（/） 开头，支持大小写字母、数字和特殊字符`.-_/=?:`。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。默认值为`${query}`，您还可以输入其他查询字符串信息，查询字符串长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和特殊字符`[]{}<>\\#|&`。'."\n" + ."\n" + .' - `code`：跳转方式。支持`301`、`302`、`303`、`307`或`308`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**FixResponse**时，该参数为返回固定响应配置信息。取值样例为`{"code":"200", "type":"text/plain", "content":"dssacav" }`，其中：'."\n" + .' - `code`：响应状态码。仅支持`2xx`、`4xx`、`5xx`数字型字符串，`x`为任意数字。'."\n" + ."\n" + .' - `type`：响应正文类型。仅支持**text/plain**, **text/css**, **text/html**, **application/javascript**, **application/json**。'."\n" + ."\n" + .' - `content`：响应正文。响应正文长度不能超过1000个字符，不支持中文字符。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**AddHeader**时，该参数为插入HTTP标头字段配置信息。转发规则中存在**AddHeader**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。取值样例为`[{"name":"header1","type":"userdefined", "value":"value"}]`，其中：'."\n" + ."\n" + .' - `name`：HTTP标头字段名称。名称长度为1~40字符，支持大小写字母、数字、短划线（-）和下划线（_）。**AddHeader**中的HTTP标头字段名称不能重复，也不能和**RemoveHeader**中的HTTP标头字段名称重复。'."\n" + ."\n" + .' - `type`：HTTP标头字段内容类型。取值范围为`user-defined`（用户指定）、`ref`（引用）、`system-defined`（系统定义）。'."\n" + ."\n" + .' - `value`：HTTP标头字段内容，内容不能为空。`type`为`user-defined`（用户指定）时，长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内的可打印字符，支持大小写字母、数字、短划线（-）和下划线（_），开头和结尾不能为空格；`type`为`ref`（引用）时，长度为1~128个字符，支持大小写字母、数字、短划线（-）和下划线（_），开头和结尾不能为空格；`type`为`system-defined`（系统定义）时，仅支持取值为`ClientSrcIp`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**RemoveHeader**时，该参数为删除HTTP标头字段信息。转发规则中存在**RemoveHeader**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。长度为1~40字符，支持大小写字母、数字、短划线（-）和下划线（_）。取值样例为`["header1"]`。'."\n" + ."\n" + .'- 当**RuleActionType**取值为**Rewrite**时，该参数为重写配置信息。转发规则中存在**Rewrite**类型的转发动作，必须同时配置一条**ForwardGroup**类型的转发动作。取值样例为`{"domain":"value1", "path":"value2", "query":"value3"}`，其中：'."\n" + ."\n" + .' - `domain`：要跳转的域名。默认值为`${host}`，您还可以输入其他域名信息，域名长度为3~128个字符，只允许包含小写字母、数字和特殊字符`.-?=~_-+/^*!$&|()[]`。'."\n" + ."\n" + .' - `path`：要跳转的路径。默认值为`${path}`，路径长度限制为1~128个字符。正则表达式类型的路径，必须以波浪线（~）开头，支持的大小写字母、数字和特殊字符`.-_/=?~^*$:()[]+|`；非正则表达式类型的路径，必须以正斜线（/） 开头，支持大小写字母、数字和特殊字符`.-_/=?:`。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。默认值为`${query}`，您还可以输入其他查询字符串信息，查询字符串长度为1~128个字符，支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符，如果是字母必须为小写字母，不支持空格和特殊字符`[]{}<>\\#|&`。'."\n" + .'- 当**RuleActionType**取值为**Drop**时，该参数无需填写。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]', + ], + 'ForwardGroupConfig' => [ + 'description' => '转发配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'object', + 'properties' => [ + 'ServerGroupTuples' => [ + 'description' => '终端节点组配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组配置。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。'."\n" + .'> 不推荐使用该参数，建议直接使用**RuleActionType**和**RuleActionValue**配置转发动作。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1ieei9664r5nv****', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + 'ForwardingRuleId' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'frule-bp1dii16gu9qdvb34****', + ], + 'ForwardingRuleName' => [ + 'description' => '转发策略名称。'."\n" + ."\n" + .'名称长度为2~128个英文或中文字符，必须以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'RuleDirection' => [ + 'description' => '规则生效方向。无需配置。'."\n" + ."\n" + .'目前默认为**request**，表示请求方向生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'request', + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => 'test', + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'ForwardingRules' => [ + 'description' => '转发策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略信息。', + 'type' => 'object', + 'properties' => [ + 'ForwardingRuleId' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp1dii16gu9qdvb34****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + [ + 'errorCode' => 'RepeatPathAndHost.ForwardingRule', + 'errorMessage' => 'The path and host %s are duplicated.', + ], + [ + 'errorCode' => 'QuotaExceeded.RuleConditionConfig', + 'errorMessage' => 'The number of paths and hosts exceeds the limit.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.ForwardingRule', + 'errorMessage' => 'The forwarding rule %s does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ForwardingRules\\": [\\n {\\n \\"ForwardingRuleId\\": \\"frule-bp1dii16gu9qdvb34****\\"\\n }\\n ],\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateForwardingRulesResponse>\\n <ForwardingRules>\\n <ForwardingRuleId>frule-bp1dii16gu9qdvb34****</ForwardingRuleId>\\n </ForwardingRules>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n</UpdateForwardingRulesResponse>","errorExample":""}]', + 'title' => '更新转发规则', + 'summary' => '调用UpdateForwardingRules接口更新转发策略。', + 'description' => '- **UpdateForwardingRules**接口属于异步接口，即系统会先返回一个请求ID，但转发策略并未修改完成，系统后台的修改任务仍在进行。您可以调用[ListForwardingRules](~~205817~~)查询转发策略的状态：'."\n" + .' - 当转发策略处于**configuring**状态时，表示转发策略正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当转发策略处于**active**状态时，表示转发策略修改完成。'."\n" + .'- **UpdateForwardingRules**接口不支持在同一个全球加速实例内并发修改转发策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListForwardingRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8514', + 'abilityTreeNodes' => [ + 'FEATUREgaRQQP6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1s0vzbi5bxlx5pw****', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qzk****', + ], + ], + [ + 'name' => 'ForwardingRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**100**。默认值：**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'MaxResults' => [ + 'description' => '分批次查询时每次显示的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ForwardingRules' => [ + 'description' => '转发策略信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略信息列表。', + 'type' => 'object', + 'properties' => [ + 'Priority' => [ + 'description' => '转发策略优先级。'."\n" + ."\n" + .'返回为**1**~**10000**。值越小表示优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'ForwardingRuleId' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + 'ForwardingRuleName' => [ + 'description' => '转发策略名称。', + 'type' => 'string', + 'example' => 'auto_named_rule', + ], + 'ForwardingRuleDirection' => [ + 'description' => '规则生效方向。'."\n" + ."\n" + .'目前默认返回**request**，表示请求方向生效。', + 'type' => 'string', + 'example' => 'request', + ], + 'ForwardingRuleStatus' => [ + 'description' => '转发策略状态。'."\n" + ."\n" + .'- **active**：正常。'."\n" + .'- **configuring**：变配中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'RuleConditions' => [ + 'description' => '转发条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '转发条件列表。', + 'type' => 'object', + 'properties' => [ + 'RuleConditionType' => [ + 'description' => '转发条件类型。'."\n" + .'- **Host**：域名。'."\n" + .'- **Path**：路径。'."\n" + .'- **RequestHeader**：HTTP标头。'."\n" + .'- **Query**：查询字符串。'."\n" + .'- **Method**：HTTP请求方法。'."\n" + .'- **Cookie**：Cookie。'."\n" + .'- **SourceIP**：源IP。', + 'type' => 'string', + 'example' => 'Host', + ], + 'RuleConditionValue' => [ + 'description' => '转发条件类型对应的值。'."\n" + ."\n" + .'根据**RuleConditionType**返回不同的JSON字符串值。'."\n" + ."\n" + .'- 当**RuleConditionType**为**Host**时，该参数返回域名条件配置信息。若一个转发规则内返回多个域名，多个域名间为“或”关系。'."\n" + ."\n" + .'- 当**RuleConditionType**为**Path**时，该参数返回路径条件配置信息。一个转发策略若返回多个路径类型转发规则，多个路径类型转发规则间为”或“关系，一个转发路径类型规则若返回多个路径，多个路径间为“或”关系。'."\n" + ."\n" + .'- 当**RuleConditionType**为**RequestHeader**时，该参数返回HTTP标头字段条件配置信息，由键（Key）和值（Value）组成。'."\n" + ."\n\n" + .'- 当**RuleConditionType**为**Query**时，该参数返回查询字符串条件配置信息，由键（Key）和值（Value）组成。'."\n" + ."\n" + .' '."\n" + .'- 当**RuleConditionType**为**Method**时，该参数返回请求方法配置信息。'."\n" + ."\n" + .'- 当**RuleConditionType**为**Cookie**时，该参数返回Cookie配置信息，由键（Key）和值（Value）组成。'."\n" + ."\n" + .'- 当**RuleConditionType**为**SourceIP**时，该参数返回源IP配置信息。若一个转发规则内返回了多个源IP，多个IP之间为“或”关系。', + 'type' => 'string', + 'example' => '["www.example.com", "www.aliyun.com"]', + ], + 'PathConfig' => [ + 'description' => '路径配置信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '路径配置信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '路径。'."\n" + ."\n" + .'路径长度为1~128个字符，必须以正斜线（/）开头，只允许包含字母、数字、美元符号（$）、短划线（-）、下划线（_）、半角句号（.）、加号（+）、正斜线（/）、and（&）、波浪线（~）、at（@）、半角冒号（:）、半角单引号（\'），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + ."\n\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'string', + 'example' => '/test', + ], + ], + ], + ], + 'HostConfig' => [ + 'description' => '域名配置信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'object', + 'properties' => [ + 'Values' => [ + 'description' => '域名配置信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '域名。'."\n" + ."\n" + .'域名长度为3~128个字符，允许包含字母、数字、短划线（-）和半角句号（.），支持使用星号（*）和半角问号（?）作为通配符。'."\n" + ."\n\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleConditionType**和**RuleConditionValue**查看转发条件信息。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + ], + ], + ], + ], + ], + ], + 'RuleActions' => [ + 'description' => '转发动作。', + 'type' => 'array', + 'items' => [ + 'description' => '转发动作。', + 'type' => 'object', + 'properties' => [ + 'Order' => [ + 'description' => '转发优先级。'."\n" + ."\n" + .'> 当前无实际意义。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleActionType' => [ + 'description' => '转发动作类型。'."\n" + .'- **ForwardGroup**：转发。'."\n" + .'- **Redirect**：重定向。'."\n" + .'- **FixResponse**：返回固定响应。'."\n" + .'- **Rewrite**：重写。'."\n" + .'- **AddHeader**：写入头字段。'."\n" + .'- **RemoveHeader**：删除头字段。'."\n" + .'- **Drop**：丢弃。', + 'type' => 'string', + 'example' => 'ForwardGroup', + ], + 'RuleActionValue' => [ + 'description' => '转发动作类型对应的值。'."\n" + ."\n" + .'根据**RuleActionType**返回不同的JSON字符串值。'."\n" + ."\n" + .'- 当**RuleActionType**为**ForwardGroup**时，该参数返回虚拟终端节点组信息。其中：'."\n" + ."\n" + .' - `type`：`endpointgroup`。'."\n" + ."\n" + .' - `value`：目标虚拟终端节点组ID。'."\n" + ."\n" + .'- 当**RuleActionType**为**Redirect**时，该参数返回重定向配置信息。其中：'."\n" + ."\n" + .' - `protocol`：要跳转的协议。'."\n" + ."\n" + .' - `domain`：要跳转的域名。'."\n" + ."\n" + .' - `port`：要跳转的端口。'."\n" + ."\n" + .' - `path`：要跳转的路径。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。'."\n" + ."\n" + .' - `code`：跳转方式。'."\n" + ."\n" + .'- 当**RuleActionType**为**FixResponse**时，该参数返回配置的返回固定响应信息。其中：'."\n" + ."\n" + .' - `code`：响应状态码。'."\n" + ."\n" + .' - `type`：响应正文类型。'."\n" + ."\n" + .' - `content`：响应正文。'."\n" + ."\n" + .'- 当**RuleActionType**为**AddHeader**时，该参数返回插入HTTP标头字段配置信息。其中：'."\n" + ."\n" + .' - `name`：HTTP标头字段名称。'."\n" + ."\n" + .' - `type`：HTTP标头字段内容类型。'."\n" + ."\n" + .' - `value`：HTTP标头字段内容。'."\n" + ."\n" + .'- 当**RuleActionType**为**RemoveHeader**时，该参数返回删除HTTP标头字段信息。'."\n" + ."\n" + .'- 当**RuleActionType**为**Rewrite**时，该参数返回重写配置信息。其中：'."\n" + ."\n" + .' - `domain`：要跳转的域名。'."\n" + ."\n" + .' - `path`：要跳转的路径。'."\n" + ."\n" + .' - `query`：要跳转的查询字符串。'."\n" + .'- 当**RuleActionType**取值为**Drop**时，该参数返回空字符串。', + 'type' => 'string', + 'example' => '[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]', + ], + 'ForwardGroupConfig' => [ + 'description' => '转发动作配置信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleActionType**和**RuleActionValue**查看转发动作信息。', + 'type' => 'object', + 'properties' => [ + 'ServerGroupTuples' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleActionType**和**RuleActionValue**查看转发动作信息。', + 'type' => 'array', + 'items' => [ + 'description' => '终端节点组信息。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleActionType**和**RuleActionValue**查看转发动作信息。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'description' => '终端节点组ID。'."\n" + ."\n" + .'> 针对2022年07月12日之后创建的全球加速实例，支持所有转发条件类型和转发动作类型，建议通过**RuleActionType**和**RuleActionValue**查看转发动作信息。', + 'type' => 'string', + 'example' => 'epg-bp1enpdcrqhl78g6r****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'ListenerId' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1s0vzbi5bxlx5****', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + .'- **true**：是托管实例。'."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + ."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + ."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 20,\\n \\"ForwardingRules\\": [\\n {\\n \\"Priority\\": 1000,\\n \\"ForwardingRuleId\\": \\"frule-bp19a3t3yzr21q3****\\",\\n \\"ForwardingRuleName\\": \\"auto_named_rule\\",\\n \\"ForwardingRuleDirection\\": \\"request\\",\\n \\"ForwardingRuleStatus\\": \\"active\\",\\n \\"RuleConditions\\": [\\n {\\n \\"RuleConditionType\\": \\"Host\\",\\n \\"RuleConditionValue\\": \\"[\\\\\\"www.example.com\\\\\\", \\\\\\"www.aliyun.com\\\\\\"]\\",\\n \\"PathConfig\\": {\\n \\"Values\\": [\\n \\"/test\\"\\n ]\\n },\\n \\"HostConfig\\": {\\n \\"Values\\": [\\n \\"www.example.com\\"\\n ]\\n }\\n }\\n ],\\n \\"RuleActions\\": [\\n {\\n \\"Order\\": 1,\\n \\"RuleActionType\\": \\"ForwardGroup\\",\\n \\"RuleActionValue\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"endpointgroup\\\\\\", \\\\\\"value\\\\\\":\\\\\\"epg-bp1enpdcrqhl78g6r****\\\\\\"}]\\",\\n \\"ForwardGroupConfig\\": {\\n \\"ServerGroupTuples\\": [\\n {\\n \\"EndpointGroupId\\": \\"epg-bp1enpdcrqhl78g6r****\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"ListenerId\\": \\"lsr-bp1s0vzbi5bxlx5****\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListForwardingRulesResponse>\\n <RequestId>CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>20</MaxResults>\\n <ForwardingRules>\\n <Priority>1000</Priority>\\n <ForwardingRuleId>frule-bp19a3t3yzr21q3****</ForwardingRuleId>\\n <ForwardingRuleName>auto_named_rule</ForwardingRuleName>\\n <ForwardingRuleDirection>request</ForwardingRuleDirection>\\n <ForwardingRuleStatus>active</ForwardingRuleStatus>\\n <RuleConditions>\\n <RuleConditionType>Host</RuleConditionType>\\n <RuleConditionValue>[\\"www.example.com\\", \\"www.aliyun.com\\"]</RuleConditionValue>\\n <PathConfig>\\n <Values>/test</Values>\\n </PathConfig>\\n <HostConfig>\\n <Values>www.example.com</Values>\\n </HostConfig>\\n </RuleConditions>\\n <RuleActions>\\n <Order>1</Order>\\n <RuleActionType>ForwardGroup</RuleActionType>\\n <RuleActionValue>[{\\"type\\":\\"endpointgroup\\", \\"value\\":\\"epg-bp1enpdcrqhl78g6r****\\"}]</RuleActionValue>\\n <ForwardGroupConfig>\\n <ServerGroupTuples>\\n <EndpointGroupId>epg-bp1enpdcrqhl78g6r****</EndpointGroupId>\\n </ServerGroupTuples>\\n </ForwardGroupConfig>\\n </RuleActions>\\n <ListenerId>lsr-bp1s0vzbi5bxlx5****</ListenerId>\\n </ForwardingRules>\\n</ListForwardingRulesResponse>","errorExample":""}]', + 'title' => '获取转发规则列表', + 'summary' => '调用ListForwardingRules接口获取转发规则列表。', + 'description' => '> 调用该接口只能查看自定义转发策略信息，无法查看默认转发策略信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteForwardingRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8513', + 'abilityTreeNodes' => [ + 'FEATUREgaRQQP6R', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'ForwardingRuleIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '转发策略。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + 'required' => true, + 'example' => 'frule-bp19a3t3yzr21q3****', + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4q****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1s0vzbi5bxlx5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'ForwardingRules' => [ + 'description' => '转发策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '转发策略ID。', + 'type' => 'object', + 'properties' => [ + 'ForwardingRuleId' => [ + 'description' => '转发策略ID。', + 'type' => 'string', + 'example' => 'frule-bp19a3t3yzr21q3****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'The state of the listener is not active.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndPoint', + 'errorMessage' => 'The maximum number of endpoints is exceeded.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'NoPermission.VpcEndpoint', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'NotExist.ForwardingRule', + 'errorMessage' => 'forwarding rule %s is not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ForwardingRules\\": [\\n {\\n \\"ForwardingRuleId\\": \\"frule-bp19a3t3yzr21q3****\\"\\n }\\n ],\\n \\"RequestId\\": \\"CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteForwardingRulesResponse>\\n <ForwardingRules>\\n <ForwardingRuleId>frule-bp19a3t3yzr21q3****</ForwardingRuleId>\\n </ForwardingRules>\\n <RequestId>CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4</RequestId>\\n</DeleteForwardingRulesResponse>","errorExample":""}]', + 'title' => '删除转发规则', + 'summary' => '调用DeleteForwardingRules接口删除转发规则。', + 'description' => '- **DeleteForwardingRules**接口属于异步接口，即系统会先返回一个请求ID，但转发策略并未删除完成，系统后台的删除任务仍在进行。您可以调用[ListForwardingRules](~~205817~~)查询转发策略的状态：'."\n" + .' - 当转发策略处于**deleting**状态时，表示转发策略正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到要删除的转发策略时，表示转发策略删除完成。'."\n" + .'- **DeleteForwardingRules**接口不支持在同一个全球加速实例内并发删除转发策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAcl' => [ + 'summary' => '调用CreateAcl接口创建访问控制策略组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21653', + 'abilityTreeNodes' => [ + 'FEATUREgaUP4965', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组的名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-acl', + ], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组的IP版本。取值：'."\n" + .'- **IPv4**。'."\n" + .'- **IPv6**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'IPv4', + 'enum' => [ + 'IPv4', + 'IPv6', + ], + ], + ], + [ + 'name' => 'AclEntries', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + ."\n" + .'一次最多支持添加50个条目。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + ."\n" + .'一次最多支持添加50个条目。', + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + 'description' => '访问控制策略组条目，即IP地址条目(192.168.XX.XX)或IP地址段条目(10.0.XX.XX/24)。'."\n" + ."\n" + .'一次最多支持添加50个条目。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX/24', + ], + 'EntryDescription' => [ + 'description' => '访问控制策略组条目备注内容。'."\n" + ."\n" + .'一次最多支持添加50个条目备注。'."\n" + ."\n" + .'长度限制为1~256个字符，允许包含字母、数字、短划线（-）、正斜线（/）、半角句号（.）和下划线（_），支持中文字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-entry', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF3898', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建访问控制策略组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwj7wvng3jbi', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略组的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '访问控制策略组的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '访问控制策略组的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IsExist.AclEntriesIsExist', + 'errorMessage' => 'acl entries %s is exist', + ], + [ + 'errorCode' => 'QuotaExceeded.AclEntries', + 'errorMessage' => 'The number of acl entries exceeds the limit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAclResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n</CreateAclResponse>","errorExample":""}]', + 'title' => '创建访问控制策略组', + 'description' => '**CreateAcl**接口属于异步接口，即系统会先返回一个访问控制策略组ID，但访问控制策略组并未创建完成，系统后台的创建任务仍在进行。您可以调用[GetAcl](~~258292~~)或[ListAcls](~~258291~~)查询访问控制策略组的状态：'."\n" + .'- 当访问控制策略组处于**init**状态时，表示访问控制策略组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .'- 当访问控制策略组处于**active**状态时，表示访问控制策略组创建完成。', + ], + 'UpdateAclAttribute' => [ + 'summary' => '调用UpdateAclAttribute接口修改访问控制策略组属性。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21726', + 'abilityTreeNodes' => [ + 'FEATUREga7ASVBS', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + [ + 'name' => 'AclName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test-acl', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改访问控制策略组属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + ."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAclAttributeResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n</UpdateAclAttributeResponse>","errorExample":""}]', + 'title' => '修改访问控制策略组属性', + ], + 'AddEntriesToAcl' => [ + 'summary' => '为访问控制策略组添加IP条目，并通过设置白名单或黑名单来允许或者限制监听对这些IP条目访问请求的转发，可实现客户端请求的精确控制。您可以通过调用AddEntriesToAcl接口在访问控制策略组中添加IP条目。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '22289', + 'abilityTreeNodes' => [ + 'FEATUREga7ASVBS', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + [ + 'name' => 'AclEntries', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要添加的访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + ."\n" + .'一次最多支持添加50个条目。', + 'type' => 'array', + 'items' => [ + 'description' => '需要添加的访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + .'一次最多支持添加50个条目。', + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + 'description' => '需要添加的访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + .'一次最多支持添加50个条目。'."\n" + ."\n" + .'> 该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX/24', + ], + 'EntryDescription' => [ + 'description' => '访问控制策略组条目备注内容。'."\n" + ."\n" + .'一次最多支持添加50个条目备注。'."\n" + ."\n" + .'长度限制为1~256个字符，允许包含字母、数字、短划线（-）、正斜线（/）、半角句号（.）和下划线（_），支持中文字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-entry', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF3898', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会在访问控制策略组中添加IP条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '365F4154-92F6-4AE4-92F8-7FF34B540710', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl %s is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state %s is illegal', + ], + [ + 'errorCode' => 'IsExist.AclEntriesIsExist', + 'errorMessage' => 'acl entries %s is exist', + ], + [ + 'errorCode' => 'QuotaExceeded.AclEntries', + 'errorMessage' => 'The number of acl entries exceeds the limit', + ], + [ + 'errorCode' => 'Repeat.AclEntries', + 'errorMessage' => 'acl entries repeat', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"365F4154-92F6-4AE4-92F8-7FF34B540710\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddEntriesToAclResponse>\\n <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n</AddEntriesToAclResponse>","errorExample":""}]', + 'title' => '在访问控制策略组中添加IP条目', + 'description' => '- **AddEntriesToAcl**接口属于异步接口，即系统会先返回一个请求ID，但IP条目并未添加完成，系统后台的添加任务仍在进行。您可以调用[GetAcl](~~258292~~)或[ListAcls](~~258291~~)查询访问控制策略组的状态：'."\n" + .' - 当访问控制策略组处于**configuring**状态时，表示IP条目正在添加中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当访问控制策略组处于**active**状态时，表示IP条目添加完成。'."\n" + .'- **AddEntriesToAcl**接口不支持在同一个全球加速实例内并发为访问控制策略组添加IP条目。', + ], + 'RemoveEntriesFromAcl' => [ + 'summary' => '调用RemoveEntriesFromAcl接口删除访问控制策略组中的IP条目。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '22290', + 'abilityTreeNodes' => [ + 'FEATUREga7ASVBS', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + [ + 'name' => 'AclEntries', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待删除的访问控制策略组条目，一次最多支持删除50条。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除的访问控制策略组条目，一次最多支持删除50条。', + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + 'description' => '访问控制策略组条目，即IP地址条目或IP地址段条目。'."\n" + .'一次最多支持删除50条。'."\n" + ."\n" + .'> 该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.XX.XX/24', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl %s is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.AclEntries', + 'errorMessage' => 'acl entries is not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveEntriesFromAclResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n</RemoveEntriesFromAclResponse>","errorExample":""}]', + 'title' => '删除访问控制策略组中的IP条目', + 'description' => '- **RemoveEntriesFromAcl**接口属于异步接口，即系统会先返回一个请求ID，但IP条目并未删除完成，系统后台的删除任务仍在进行。您可以调用[GetAcl](~~258292~~)或[ListAcls](~~258291~~)查询访问控制策略组的状态：'."\n" + .' - 当访问控制策略组处于**configuring**状态时，表示IP条目正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当访问控制策略组处于**active**状态时，表示IP条目删除完成。'."\n" + .'- **RemoveEntriesFromAcl**接口不支持在同一个全球加速实例内并发删除访问控制策略组中的IP条目。', + ], + 'ListAcls' => [ + 'summary' => '调用ListAcls接口查询访问控制列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21718', + 'abilityTreeNodes' => [ + 'FEATUREgaUP4965', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AclIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '访问控制策略组ID，一次最多支持查询10个访问控制策略组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组ID，一次最多支持查询10个访问控制策略组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'AclName', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组名称。一次最多支持查询10个访问控制策略组名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-acl', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页显示的条目数。取值范围：**1**~**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2lgw4evw****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '访问控制策略组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '访问控制策略组的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '访问控制策略组的标签值。一旦输入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'最多支持输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70t****', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页显示的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Acls' => [ + 'description' => '访问控制策略组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组列表。', + 'type' => 'object', + 'properties' => [ + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + 'AclName' => [ + 'description' => '访问控制策略组名称。', + 'type' => 'string', + 'example' => 'test-acl', + ], + 'AddressIPVersion' => [ + 'description' => '访问控制策略组的IP版本。'."\n" + .'- **IPv4**。'."\n" + .'- **IPv6**。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'AclStatus' => [ + 'description' => '访问控制策略组的状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2lgw4evw****', + ], + 'Tags' => [ + 'description' => '访问控制策略组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '访问控制策略组的标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '访问控制策略组的标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70t****\\",\\n \\"MaxResults\\": 10,\\n \\"Acls\\": [\\n {\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\",\\n \\"AclName\\": \\"test-acl\\",\\n \\"AddressIPVersion\\": \\"IPv4\\",\\n \\"AclStatus\\": \\"active\\",\\n \\"ResourceGroupId\\": \\"rg-aek2lgw4evw****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAclsResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70t****</NextToken>\\n <MaxResults>10</MaxResults>\\n <Acls>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n <AclName>test-acl</AclName>\\n <AddressIPVersion>IPv4</AddressIPVersion>\\n <AclStatus>active</AclStatus>\\n <ResourceGroupId>rg-aek2lgw4evw****</ResourceGroupId>\\n <Tags>\\n <Key>tag-key</Key>\\n <Value>tag-value</Value>\\n </Tags>\\n </Acls>\\n</ListAclsResponse>","errorExample":""}]', + 'title' => '查询ACL列表', + ], + 'GetAcl' => [ + 'summary' => '调用GetAcl接口获取访问控制策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21724', + 'abilityTreeNodes' => [ + 'FEATUREgaUP4965', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + 'AddressIPVersion' => [ + 'description' => '访问控制策略组的IP版本。'."\n" + .'- **IPv4**。'."\n" + .'- **IPv6**。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'AclStatus' => [ + 'description' => '访问控制策略组状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **configuring**：配置中。'."\n" + .'- **updating**：更新中。'."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'AclEntries' => [ + 'description' => '添加的访问控制条目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '添加的访问控制条目列表。', + 'type' => 'object', + 'properties' => [ + 'Entry' => [ + 'description' => '访问控制IP地址条目(192.168.XX.XX)或IP地址段条目(10.0.XX.XX/24)。', + 'type' => 'string', + 'example' => '10.0.XX.XX/24', + ], + 'EntryDescription' => [ + 'description' => '访问控制条目备注内容。', + 'type' => 'string', + 'example' => 'test-entry', + ], + ], + ], + ], + 'RelatedListeners' => [ + 'description' => '关联的监听列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联的监听列表。', + 'type' => 'object', + 'properties' => [ + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'AclType' => [ + 'description' => '访问控制类型。'."\n" + ."\n" + .'- **white**：仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求，白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的IP可以访问全球加速实例监听。如果开启了白名单访问，但访问策略组中没有添加任何IP，则全球加速监听会转发全部请求。'."\n" + ."\n" + .'- **black**：来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发，黑名单适用于应用只限制某些特定IP访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何IP，则全球加速实例监听会转发全部请求。', + 'type' => 'string', + 'example' => 'white', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + ], + 'AclName' => [ + 'description' => '访问控制策略组的名称。', + 'type' => 'string', + 'example' => 'test-acl', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmx7itmygzsza', + ], + 'Tags' => [ + 'description' => '访问控制策略组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\",\\n \\"AddressIPVersion\\": \\"IPv4\\",\\n \\"AclStatus\\": \\"active\\",\\n \\"AclEntries\\": [\\n {\\n \\"Entry\\": \\"10.0.XX.XX/24\\",\\n \\"EntryDescription\\": \\"test-entry\\"\\n }\\n ],\\n \\"RelatedListeners\\": [\\n {\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"AclType\\": \\"white\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\"\\n }\\n ],\\n \\"AclName\\": \\"test-acl\\",\\n \\"ResourceGroupId\\": \\"rg-acfmx7itmygzsza\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetAclResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n <AddressIPVersion>IPv4</AddressIPVersion>\\n <AclStatus>active</AclStatus>\\n <AclEntries>\\n <Entry>10.0.XX.XX/24</Entry>\\n <EntryDescription>test-entry</EntryDescription>\\n </AclEntries>\\n <RelatedListeners>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <AclType>White</AclType>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n </RelatedListeners>\\n <AclName>test-acl</AclName>\\n</GetAclResponse>","errorExample":""}]', + 'title' => '获取访问控制策略', + ], + 'DeleteAcl' => [ + 'summary' => '调用DeleteAcl接口删除访问控制策略组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '21659', + 'abilityTreeNodes' => [ + 'FEATUREgaUP4965', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '365F4154-92F6-4AE4-92F8-7FF34B540710', + ], + 'AclId' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl %s is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"365F4154-92F6-4AE4-92F8-7FF34B540710\\",\\n \\"AclId\\": \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAclResponse>\\n <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>\\n <AclId>nacl-hp34s2h0xx1ht4nwo****</AclId>\\n</DeleteAclResponse>","errorExample":""}]', + 'title' => '删除访问控制', + 'description' => '**DeleteAcl**接口属于异步接口，即系统会先返回一个请求ID，但访问控制策略组并未删除完成，系统后台的删除任务仍在进行。您可以调用[GetAcl](~~258292~~)查询访问控制策略组的状态：'."\n" + .'- 当访问控制策略组处于**deleting**状态时，表示访问控制策略组正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .'- 当查询不到该访问控制策略组时，表示访问控制策略组删除完成。', + ], + 'AssociateAclsWithListener' => [ + 'summary' => '调用AssociateAclsWithListener接口将访问控制策略组（ACL）关联到监听。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '22291', + 'abilityTreeNodes' => [ + 'FEATUREgaZ38IM8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略组ID，最多支持关联2个访问控制策略组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组ID，最多支持关联2个访问控制策略组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 2, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。'."\n" + ."\n" + .'仅智能路由类型监听支持使用访问控制功能。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'AclType', + 'in' => 'query', + 'schema' => [ + 'description' => '访问控制类型。取值：'."\n" + .'- **white**：仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求，白名单适用于只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的IP可以访问全球加速监听。如果开启了白名单访问，但访问策略组中没有添加任何IP，则全球加速监听会转发全部请求。'."\n" + .'- **black**：来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发，黑名单适用于只限制某些特定IP访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何IP，则全球加速监听会转发全部请求。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'white', + 'enum' => [ + 'white', + 'black', + ], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '02fb3da4****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会关联资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF', + ], + 'AclIds' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl %s is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state %s is illegal', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF\\",\\n \\"AclIds\\": [\\n \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n ],\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\"\\n}","errorExample":""},{"type":"xml","example":"<AssociateAclsWithListenerResponse>\\n <RequestId>64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF</RequestId>\\n <AclIds>nacl-hp34s2h0xx1ht4nwo****</AclIds>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n</AssociateAclsWithListenerResponse>","errorExample":""}]', + 'title' => '关联ACL到监听', + 'description' => '- **AssociateAclsWithListener**接口属于异步接口，即系统会先返回一个请求ID，但访问控制策略组与监听并未关联完成，系统后台的关联任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**updating**状态时，表示访问控制策略组与监听正在关联中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示访问控制策略组与监听关联完成。'."\n" + .'- **AssociateAclsWithListener**接口不支持在同一个全球加速实例内并发关联访问控制策略组与监听。', + ], + 'DissociateAclsFromListener' => [ + 'summary' => '调用DissociateAclsFromListener接口将访问控制策略组（ACL）与监听解除关联。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '22292', + 'abilityTreeNodes' => [ + 'FEATUREgaZ38IM8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AclIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问控制策略组ID，一次最多支持将2个访问控制策略组与监听解除关联。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组ID，一次最多支持将2个访问控制策略组与监听解除关联。', + 'type' => 'string', + 'required' => false, + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF3898', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会将访问控制策略组与监听解除关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + 'AclIds' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '访问控制策略组ID。', + 'type' => 'string', + 'example' => 'nacl-hp34s2h0xx1ht4nwo****', + ], + ], + 'ListenerId' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Acl', + 'errorMessage' => 'acl %s is not exist', + ], + [ + 'errorCode' => 'StateError.Acl', + 'errorMessage' => 'acl state %s is illegal', + ], + [ + 'errorCode' => 'AclNotBindListener', + 'errorMessage' => 'acl %s not bind listener', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"AclIds\\": [\\n \\"nacl-hp34s2h0xx1ht4nwo****\\"\\n ],\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\"\\n}","errorExample":""},{"type":"xml","example":"<DissociateAclsFromListenerResponse>\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\n <AclIds>nacl-hp34s2h0xx1ht4nwo****</AclIds>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n</DissociateAclsFromListenerResponse>","errorExample":""}]', + 'title' => '将ACL与监听解除关联', + 'description' => '- **DissociateAclsFromListener**接口属于异步接口，即系统会先返回一个请求ID，但访问控制策略组与监听解除关联并未完成，系统后台的解关联任务仍在进行。您可以调用[DescribeListener](~~153254~~)查询监听的状态：'."\n" + .' - 当监听处于**updating**状态时，表示访问控制策略组与监听正在解除关联中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当监听处于**active**状态时，表示访问控制策略组与监听已解除关联。'."\n" + .'- **DissociateAclsFromListener**接口不支持在同一个全球加速实例内并发解除访问控制策略组与监听的关联。', + ], + 'CreateApplicationMonitor' => [ + 'summary' => '调用CreateApplicationMonitor接口创建源站探测任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要探测的全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要探测的监听实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测的任务名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '需要探测的URL或IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }', + ], + ], + [ + 'name' => 'DetectEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动诊断功能。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DetectThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '设置自动诊断触发阈值。单位：%。'."\n" + ."\n" + .'取值范围：**0**~**100**。'."\n" + ."\n" + .'默认值：**0**，表示不触发自动诊断。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'DetectTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '触发自动诊断需要达到触发阈值的次数。'."\n" + ."\n" + .'取值范围：**1**~**20**。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '自动诊断触发沉默时间。表示自动诊断触发后，未恢复到正常，间隔多久触发一次自动诊断。'."\n" + ."\n" + .'可用率连续多次（即设置的**DetectTimes**）低于自动诊断触发阈值时，触发自动诊断，如果可用率在自动诊断触发沉默时间内持续低于自动诊断触发阈值，在自动诊断触发沉默时间内不会重复出发自动诊断；如果可用率在自动诊断触发沉默时间后仍未恢复正常，则再次触发自动诊断。'."\n" + ."\n" + .'单位：秒。取值范围：**300**~**86400**。默认值：**300**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TaskId' => [ + 'description' => '源站探测的任务ID。', + 'type' => 'string', + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'The listener does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TaskId\\": \\"sm-bp1fpdjfju9k8yr1y****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TaskId>sm-bp1fpdjfju9k8yr1y****</TaskId>\\n</CreateApplicationMonitorResponse>","errorExample":""}]', + 'title' => '创建源站探测任务', + 'description' => '您可以使用**CreateApplicationMonitor**接口创建源站探测任务，实时监测从探测点经过全球加速至源站的全链路网络质量，从而快速定位网络故障，针对性的进行网络优化。'."\n" + ."\n" + .'调用本接口，请注意以下事项：'."\n" + ."\n" + .'- 仅包年包月、中型Ⅰ及以上规格的标准型全球加速实例支持创建源站探测任务。'."\n" + .'- 不支持为UDP协议监听创建源站探测任务。'."\n" + .'- 监控地址的服务端口需在监听端口范围内。'."\n" + .'- **CreateApplicationMonitor**接口属于异步接口，即系统会先返回一个源站探测的任务ID，但源站探测任务并未创建完成，系统后台的创建任务仍在进行。您可以调用[DescribeApplicationMonitor](~~408463~~)或[ListApplicationMonitor](~~408462~~)查询源站探测任务的状态：'."\n" + ."\n" + .' - 当源站探测任务处于**init**状态时，表示源站探测任务正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当源站探测任务处于**active**状态时，表示源站探测任务创建完成。'."\n" + ."\n" + .'- **CreateApplicationMonitor**接口不支持在同一个全球加速实例内并发创建源站探测任务。', + ], + 'UpdateApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114792', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改源站探测的任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改源站探测的监听实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测的任务名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'task1', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '需要探测的URL或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }', + ], + ], + [ + 'name' => 'DetectEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动诊断功能。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DetectThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '设置自动诊断触发阈值，当源站可用率低于设置的触发阈值，则自动触发诊断。'."\n" + ."\n" + .'取值范围：**0**~**100**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'DetectTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '触发自动诊断需要达到触发阈值的次数。'."\n" + ."\n" + .'取值范围：**1**~**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '自动诊断触发的沉默时间。表示自动诊断触发后，未恢复到正常，间隔多久触发一次自动诊断。'."\n" + ."\n" + .'可用率连续多次（即设置的**DetectTimes**）低于自动诊断触发阈值时，触发自动诊断，如果可用率在自动诊断触发的沉默时间内持续低于自动诊断触发阈值，在自动诊断触发的沉默时间内不会重复出发自动诊断；如果可用率在自动诊断触发的沉默时间后仍未恢复正常，则再次触发自动诊断。'."\n" + ."\n" + .'单位：秒。取值范围：**300**~**86400**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidateTaskId.ApplicationMonitor', + 'errorMessage' => 'The application monitor task %s is not exist.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + [ + 'errorCode' => 'ListenerNotSupport.ApplicationMonitor', + 'errorMessage' => 'when the listener protocol is udp, application monitor is not supported.', + ], + [ + 'errorCode' => 'InvalidatePort.ApplicationMonitor', + 'errorMessage' => 'The address port not in listener port range.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateApplicationMonitorResponse>","errorExample":""}]', + 'title' => '修改源站探测任务配置', + 'summary' => '调用UpdateApplicationMonitor接口修改源站探测任务配置。', + 'description' => '**UpdateApplicationMonitor**接口属于异步接口，即系统会先返回一个请求ID，但源站探测任务并未修改完成，系统后台的修改任务仍在进行。您可以调用[DescribeApplicationMonitor](~~408463~~)或[ListApplicationMonitor](~~408462~~)查询源站探测任务的配置是否完成修改：'."\n" + ."\n" + .'- 当修改的参数值未发生变更，表示源站探测任务正在修改中，在该情况下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .'- 当修改的参数值已发生变更，表示源站探测任务修改完成。', + ], + 'DisableApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114794', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要关闭的源站探测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.SiteMonitor', + 'errorMessage' => 'The siteMonitor %s is not exist.', + ], + [ + 'errorCode' => 'InvalidateTaskId.ApplicationMonitor', + 'errorMessage' => 'The application monitor task %s is not exist.', + ], + [ + 'errorCode' => 'InvalidateTaskState.ApplicationMonitor', + 'errorMessage' => 'The application task state is invalidate.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DisableApplicationMonitorResponse>","errorExample":""}]', + 'title' => '关闭源站探测', + 'summary' => '调用DisableApplicationMonitor接口关闭源站探测。', + ], + 'EnableApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114795', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要开启的源站探测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidateTaskId.ApplicationMonitor', + 'errorMessage' => 'The application monitor task %s is not exist.', + ], + [ + 'errorCode' => 'InvalidateTaskState.ApplicationMonitor', + 'errorMessage' => 'The application task state is invalidate.', + ], + [ + 'errorCode' => 'ListenerNeed.ApplicationMonitor', + 'errorMessage' => 'The listener must be configured.', + ], + [ + 'errorCode' => 'NotExist.Listener', + 'errorMessage' => 'listener %s is not exist', + ], + [ + 'errorCode' => 'NotActive.Listener', + 'errorMessage' => 'listener %s is not active', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</EnableApplicationMonitorResponse>","errorExample":""}]', + 'title' => '开启源站探测', + 'summary' => '调用EnableApplicationMonitor接口开启源站探测。', + ], + 'DeleteApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114848', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的源站探测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.SiteMonitor', + 'errorMessage' => 'The siteMonitor %s is not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteApplicationMonitorResponse>","errorExample":""}]', + 'title' => '删除源站探测任务', + 'summary' => '调用DeleteApplicationMonitor接口删除源站探测任务。', + 'description' => '- **DeleteApplicationMonitor**接口属于异步接口，即系统会先返回一个请求ID，但源站探测任务并未删除完成，系统后台的删除任务仍在进行。您可以调用[ListApplicationMonitor](~~408462~~)查询源站探测任务的状态：'."\n" + .' - 当源站探测任务处于**deleting**状态时，表示源站探测任务正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该源站探测任务时，表示源站探测任务删除完成。'."\n" + .'- **DeleteApplicationMonitor**接口不支持在同一个全球加速实例内并发删除源站探测任务。', + ], + 'ListApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114803', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '１', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**100**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务搜索关键字。支持按照URL、IP地址、全球加速实例ID和监听ID模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '总列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ApplicationMonitors' => [ + 'description' => '源站探测任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源站探测任务列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '源站探测任务对应的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '源站探测任务对应的监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'TaskId' => [ + 'description' => '源站探测任务ID。', + 'type' => 'string', + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + 'TaskName' => [ + 'description' => '源站探测的任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + 'Address' => [ + 'description' => '需要探测的URL或IP地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'OptionsJson' => [ + 'description' => '源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。', + 'type' => 'string', + 'example' => '{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }', + ], + 'DetectEnable' => [ + 'description' => '是否开启了自动诊断功能。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DetectThreshold' => [ + 'description' => '自动诊断触发阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '１', + ], + 'DetectTimes' => [ + 'description' => '触发自动诊断需要达到触发阈值的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '１', + ], + 'SilenceTime' => [ + 'description' => '自动诊断触发沉默时间。表示自动诊断触发后，未恢复到正常，间隔多久触发一次自动诊断。'."\n" + ."\n" + .'可用率连续多次（即设置的**DetectTimes**）低于自动诊断触发阈值时，触发自动诊断，如果可用率在自动诊断触发沉默时间内持续低于自动诊断触发阈值，在自动诊断触发沉默时间内不会重复出发自动诊断；如果可用率在自动诊断触发沉默时间后仍未恢复正常，则再次触发自动诊断。'."\n" + ."\n" + .'单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'State' => [ + 'description' => '源站探测任务状态。'."\n" + ."\n" + .'- **active**：启用。'."\n" + ."\n" + .'- **inactive**：停用。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ApplicationMonitors\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"TaskId\\": \\"sm-bp1fpdjfju9k8yr1y****\\",\\n \\"TaskName\\": \\"task1\\",\\n \\"Address\\": \\"https://www.aliyun.com\\",\\n \\"OptionsJson\\": \\"{ \\\\\\"http_method\\\\\\": \\\\\\"get\\\\\\",\\\\\\"header\\\\\\": \\\\\\"key:asd\\\\\\",\\\\\\"acceptable_response_code\\\\\\": \\\\\\"500\\\\\\",\\\\\\"cert_verify\\\\\\": true }\\",\\n \\"DetectEnable\\": true,\\n \\"DetectThreshold\\": 0,\\n \\"DetectTimes\\": 0,\\n \\"SilenceTime\\": 300,\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <ApplicationMonitors>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <TaskId>sm-bp1fpdjfju9k8yr1y****</TaskId>\\n <TaskName>task1</TaskName>\\n <Address>https://www.aliyun.com</Address>\\n <OptionsJson>{ \\"http_method\\": \\"get\\",\\"header\\": \\"key:asd\\",\\"acceptable_response_code\\": \\"500\\",\\"cert_verify\\": true }</OptionsJson>\\n <DetectEnable>true</DetectEnable>\\n <DetectThreshold>1</DetectThreshold>\\n <DetectTimes>1</DetectTimes>\\n <SilenceTime>300</SilenceTime>\\n <State>active</State>\\n </ApplicationMonitors>\\n</ListApplicationMonitorResponse>","errorExample":""}]', + 'title' => '查询源站探测任务列表', + 'summary' => '调用ListApplicationMonitor接口查询源站探测任务列表。', + ], + 'DescribeApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '114797', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '源站探测任务对应的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '源站探测任务对应的监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'TaskId' => [ + 'description' => '源站探测任务ID。', + 'type' => 'string', + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + 'TaskName' => [ + 'description' => '源站探测的任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + 'Address' => [ + 'description' => '需要探测的URL或IP地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'OptionsJson' => [ + 'description' => '源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。', + 'type' => 'string', + 'example' => '{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }', + ], + 'IspCityList' => [ + 'description' => '运营商探测点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运营商探测点信息列表。', + 'type' => 'object', + 'properties' => [ + 'Isp' => [ + 'description' => '运营商探测点的ID。', + 'type' => 'string', + 'example' => '465', + ], + 'IspName' => [ + 'description' => '运营商探测点的名称。', + 'type' => 'string', + 'example' => '阿里巴巴', + ], + 'City' => [ + 'description' => '运营商探测点所在城市的ID。', + 'type' => 'string', + 'example' => '375', + ], + 'CityName' => [ + 'description' => '运营商探测点所在城市的名称。', + 'type' => 'string', + 'example' => '新加坡', + ], + ], + ], + ], + 'DetectEnable' => [ + 'description' => '是否开启了自动诊断功能。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DetectThreshold' => [ + 'description' => '自动诊断触发阈值。'."\n" + ."\n" + .'当源站可用率低于触发阈值时，自动触发诊断。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DetectTimes' => [ + 'description' => '触发自动诊断需要达到触发阈值的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SilenceTime' => [ + 'description' => '自动诊断触发的沉默时间。表示自动诊断触发后，未恢复到正常，间隔多久触发一次自动诊断。'."\n" + ."\n" + .'可用率连续多次（即设置的**DetectTimes**）低于自动诊断触发阈值时，触发自动诊断，如果可用率在自动诊断触发的沉默时间内持续低于自动诊断触发阈值，在自动诊断触发的沉默时间内不会重复出发自动诊断；如果可用率在自动诊断触发的沉默时间后仍未恢复正常，则再次触发自动诊断。'."\n" + ."\n" + .'单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'RegionId' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'State' => [ + 'description' => '源站探测任务状态。'."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **updating**：配置中。'."\n" + ."\n" + .'- **inactive**：不可用。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + [ + 'errorCode' => 'NotExist.SiteMonitor', + 'errorMessage' => 'The siteMonitor %s is not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"TaskId\\": \\"sm-bp1fpdjfju9k8yr1y****\\",\\n \\"TaskName\\": \\"task1\\",\\n \\"Address\\": \\"https://www.aliyun.com\\",\\n \\"OptionsJson\\": \\"{ \\\\\\"http_method\\\\\\": \\\\\\"get\\\\\\",\\\\\\"header\\\\\\": \\\\\\"key:asd\\\\\\",\\\\\\"acceptable_response_code\\\\\\": \\\\\\"500\\\\\\",\\\\\\"cert_verify\\\\\\": true }\\",\\n \\"IspCityList\\": [\\n {\\n \\"Isp\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"City\\": \\"375\\",\\n \\"CityName\\": \\"新加坡\\"\\n }\\n ],\\n \\"DetectEnable\\": true,\\n \\"DetectThreshold\\": 0,\\n \\"DetectTimes\\": 1,\\n \\"SilenceTime\\": 300,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"State\\": \\"active\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <TaskId>sm-bp1fpdjfju9k8yr1y****</TaskId>\\n <TaskName>task1</TaskName>\\n <Address>https://www.aliyun.com</Address>\\n <OptionsJson>{ \\"http_method\\": \\"get\\",\\"header\\": \\"key:asd\\",\\"acceptable_response_code\\": \\"500\\",\\"cert_verify\\": true }</OptionsJson>\\n <IspCityList>\\n <Isp>465</Isp>\\n <IspName>阿里巴巴</IspName>\\n <City>375</City>\\n <CityName>新加坡</CityName>\\n </IspCityList>\\n <DetectEnable>true</DetectEnable>\\n <DetectThreshold>0</DetectThreshold>\\n <DetectTimes>1</DetectTimes>\\n <SilenceTime>300</SilenceTime>\\n <RegionId>cn-hangzhou</RegionId>\\n</DescribeApplicationMonitorResponse>","errorExample":""}]', + 'title' => '查询源站探测任务详细信息', + 'summary' => '调用DescribeApplicationMonitor接口查询源站探测任务详细信息。', + ], + 'DetectApplicationMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117053', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要开启诊断的源站探测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidateTaskId.ApplicationMonitor', + 'errorMessage' => 'The application monitor task %s is not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DetectApplicationMonitorResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DetectApplicationMonitorResponse>","errorExample":""}]', + 'title' => '开启诊断', + 'summary' => '调用DetectApplicationMonitor为指定源站探测任务开启诊断。', + ], + 'ListApplicationMonitorDetectResult' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '117707', + 'abilityTreeNodes' => [ + 'FEATUREgaLHYOX6', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**100**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务待查询时间段的起始时间。Unix时间戳格式，表示从1970-01-01 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1638288000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '源站探测任务待查询时间段的截止时间。Unix时间戳格式，表示从1970-01-01 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1640164683', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '总列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ApplicationMonitorDetectResultList' => [ + 'description' => '源站探测任务的诊断结果信息。', + 'type' => 'array', + 'items' => [ + 'description' => '源站探测任务的诊断结果信息。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '源站探测任务对应的全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'ListenerId' => [ + 'description' => '源站探测任务对应的监听实例ID。', + 'type' => 'string', + 'example' => 'lsr-bp1bpn0kn908w4nbw****', + ], + 'TaskId' => [ + 'description' => '源站探测的任务ID。', + 'type' => 'string', + 'example' => 'sm-bp1fpdjfju9k8yr1y****', + ], + 'Port' => [ + 'description' => '监听端口。', + 'type' => 'string', + 'example' => '80', + ], + 'Protocol' => [ + 'description' => '监听的网络传输协议类型。'."\n" + ."\n" + .'- **tcp**：TCP协议。'."\n" + ."\n" + .'- **udp**：UDP协议。'."\n" + ."\n" + .'- **http**：HTTP协议。'."\n" + ."\n" + .'- **https**：HTTPS协议。'."\n" + ."\n" + .'> UDP协议类型的监听不支持探测。', + 'type' => 'string', + 'example' => 'http', + ], + 'DiagStatus' => [ + 'description' => '源站探测任务的诊断结果。'."\n" + ."\n" + .'- **success**：源站探测任务成功。'."\n" + ."\n" + .'- **failed**：源站探测任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'StatusCode' => [ + 'description' => '源站检测任务诊断返回的错误码。', + 'type' => 'string', + 'example' => '502', + ], + 'Content' => [ + 'description' => '源站检测任务诊断返回的响应内容。', + 'type' => 'string', + 'example' => '502 BadGateway', + ], + 'Detail' => [ + 'description' => '源站探测任务的诊断结果描述。'."\n" + ."\n" + .'- **All forward nodes work well.**：未发现异常。'."\n" + .'- **Endpoint network error.**：源站异常，需要排查源站业务是否正常运行。'."\n" + .'- **Public network error.**：公网错误，一般指客户端到加速地域的网络错误。'."\n" + .'- **Ga internal error.**：内部错误，例如，全球加速实例内部处理请求异常。'."\n" + .'- **Ga has been deleted.**：当前全球加速实例已经被删除。'."\n" + .'- **Ga state is not stable**：当前全球加速实例状态不稳定，例如处于配置中。'."\n" + .'- **Ga has no listener configuration.**：当前全球加速实例无监听配置。'."\n" + .'- **Missing endpoint configuration.**：缺少终端节点配置。'."\n" + .'- **Missing acceleration region configuration.**：缺少加速地域配置。'."\n" + .'- **Missing endpointgroup configuration.**：缺少终端节点组配置。'."\n", + 'type' => 'string', + 'example' => 'All forward nodes work well', + ], + 'DetectTime' => [ + 'description' => '源站检测任务诊断结束时间。', + 'type' => 'string', + 'example' => '1663205460', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ApplicationMonitorDetectResultList\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"ListenerId\\": \\"lsr-bp1bpn0kn908w4nbw****\\",\\n \\"TaskId\\": \\"sm-bp1fpdjfju9k8yr1y****\\",\\n \\"Port\\": \\"80\\",\\n \\"Protocol\\": \\"http\\",\\n \\"DiagStatus\\": \\"success\\",\\n \\"StatusCode\\": \\"502\\",\\n \\"Content\\": \\"502 BadGateway\\",\\n \\"Detail\\": \\"All forward nodes work well\\",\\n \\"DetectTime\\": \\"1663205460\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListApplicationMonitorDetectResultResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <ApplicationMonitorDetectResultList>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>\\n <TaskId>sm-bp1fpdjfju9k8yr1y****</TaskId>\\n <Port>80</Port>\\n <Protocol>http</Protocol>\\n <DiagStatus>success</DiagStatus>\\n <StatusCode>502</StatusCode>\\n <Content>502 BadGateway</Content>\\n <Detail>All forward nodes work well</Detail>\\n <DetectTime>1663205460</DetectTime>\\n </ApplicationMonitorDetectResultList>\\n</ListApplicationMonitorDetectResultResponse>","errorExample":""}]', + 'title' => '查询源站探测任务的诊断结果', + 'summary' => '调用ListApplicationMonitorDetectResult接口查询源站探测任务的诊断结果。', + ], + 'CreateDomain' => [ + 'summary' => '调用CreateDomain接口创建域名，并关联GaId。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149715', + 'abilityTreeNodes' => [ + 'FEATUREgaN8JEXK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '全球加速实例ID。'."\n" + ."\n" + .'最多支持输入50个全球加速ID。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例ID。'."\n" + ."\n" + .'最多支持输入50个全球加速ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加的加速域名。'."\n" + ."\n" + .'仅支持添加主域名，例如`example.com`。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoIcpRecord.Domain', + 'errorMessage' => '%s has not been put on ICP record.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDomainResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateDomainResponse>","errorExample":""}]', + 'title' => '创建域名', + 'description' => '全球加速为您提供加速域名免阿里云备案服务，您只需要将已完成ICP备案的加速域名与全球加速实例进行关联，全球加速可对该加速域名及该加速域名所属主域名下的所有子域名免阿里云备案服务。'."\n" + ."\n" + .'本接口用于添加加速域名，以将加速域名与全球加速实例进行关联。在调用本接口时，请注意以下事项：'."\n" + .'- 加速域名部署在中国内地时，必须已完成ICP备案。'."\n" + .'- 同一个加速域名不能重复关联同一个全球加速实例。'."\n" + .'- **CreateDomain**接口不支持在同一个账号下并发添加加速域名。', + ], + 'UpdateDomainState' => [ + 'summary' => '调用UpdateDomainState接口更新加速域名的ICP备案状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149766', + 'abilityTreeNodes' => [ + 'FEATUREgaN8JEXK', + ], + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '待更新ICP备案状态的加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Domain' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'State' => [ + 'description' => '加速域名的ICP备案状态。'."\n" + .'- **illegal**：违规。'."\n" + .'- **inactive**：未备案。'."\n" + .'- **active**：已备案。'."\n" + .'- **unknown**：未知。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Domain', + 'errorMessage' => 'The domain %s is not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Domain\\": \\"www.example.com\\",\\n \\"State\\": \\"active\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDomainStateResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Domain>www.example.com</Domain>\\n <State>active</State>\\n</UpdateDomainStateResponse>","errorExample":""}]', + 'title' => '修改域名状态', + 'description' => '本接口用于获取加速域名最新ICP备案状态并进行更新。'."\n" + ."\n" + .'**UpdateDomainState**接口不支持在同一个账号下并发更新加速域名的ICP备案状态。', + ], + 'UpdateDomain' => [ + 'summary' => '调用UpdateDomain接口更新域名。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149722', + 'abilityTreeNodes' => [ + 'FEATUREgaN8JEXK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TargetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改的加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '新的加速域名。'."\n" + ."\n" + .'仅支持添加主域名，例如`example.net`。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.net', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Domain', + 'errorMessage' => 'The domain %s is not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDomainResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UpdateDomainResponse>","errorExample":""}]', + 'title' => '修改加速域名', + 'description' => '本接口用于修改加速域名。修改后的新加速域名部署在中国内地时，必须已完成ICP备案。'."\n" + ."\n" + .'**UpdateDomain**接口不支持在同一个账号下并发修改加速域名。', + ], + 'ListDomains' => [ + 'summary' => '调用ListDomains接口查询加速域名与状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的加速域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的加速域名ICP备案状态。取值：'."\n" + .'- **illegal**：违规。'."\n" + .'- **inactive**：未备案。'."\n" + .'- **active**：已备案。'."\n" + .'- **unknown**：未知。', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Domains' => [ + 'description' => '加速域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加速域名列表。', + 'type' => 'object', + 'properties' => [ + 'Accelerators' => [ + 'description' => '全球加速实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '全球加速实例列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'Name' => [ + 'description' => '全球加速实例名称。', + 'type' => 'string', + 'example' => 'Accelerator', + ], + 'ServiceId' => [ + 'description' => '托管实例所属的服务方ID。'."\n" + ."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。', + 'type' => 'string', + 'example' => 'ALB', + ], + 'ServiceManaged' => [ + 'description' => '是否为托管实例。取值：'."\n" + ."\n" + .'- **true**：是托管实例。'."\n" + ."\n" + .'- **false**：不是托管实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ServiceManagedInfos' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。'."\n" + .'> 仅在**ServiceManaged**参数为**True**时有效。'."\n" + .'> - 当实例处于托管状态时，用户对实例的操作会受到限制，某些操作行为会被禁止。', + 'type' => 'array', + 'items' => [ + 'description' => '用户在此托管实例下可执行的动作策略列表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '托管策略动作名称，取值：'."\n" + .'- **Create**：创建实例。'."\n" + .'- **Update**：更新当前实例。'."\n" + .'- **Delete**：删除当前实例。'."\n" + .'- **Associate**：引用/被引用当前实例。'."\n" + .'- **UserUnmanaged**：用户解托管实例。'."\n" + .'- **CreateChild**：在当前实例下创建子资源。', + 'type' => 'string', + 'example' => 'Update', + ], + 'ChildType' => [ + 'description' => '子资源类型，取值：'."\n" + ."\n" + .'- **Listener**：监听资源。'."\n" + ."\n" + .'- **IpSet**：加速地域资源。'."\n" + ."\n" + .'- **EndpointGroup**：终端节点组资源。'."\n" + ."\n" + .'- **ForwardingRule**：转发策略资源。'."\n" + ."\n" + .'- **Endpoint**：终端节点资源。'."\n" + ."\n" + .'- **EndpointGroupDestination**：自定义路由监听下的终端节点组协议映射资源。'."\n" + ."\n" + .'- **EndpointPolicy**：自定义路由监听下的终端节点通行策略资源。'."\n" + ."\n" + .'> 仅在**Action**参数为**CreateChild**时有效。', + 'type' => 'string', + 'example' => 'Listener', + ], + 'IsManaged' => [ + 'description' => '托管策略动作是否被托管，取值：'."\n" + .'- **true**：托管策略动作被托管，用户无权在托管实例下执行Action指定的操作。'."\n" + .'- **false**：托管策略动作未被托管，用户可在托管实例下执行Action指定的操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + 'Domain' => [ + 'description' => '加速域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'State' => [ + 'description' => '加速域名的ICP备案状态。'."\n" + .'- **illegal**：违规。'."\n" + .'- **inactive**：未备案。'."\n" + .'- **active**：已备案。'."\n" + .'- **unknown**：未知。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"Domains\\": [\\n {\\n \\"Accelerators\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"Name\\": \\"Accelerator\\",\\n \\"ServiceId\\": \\"ALB\\",\\n \\"ServiceManaged\\": true,\\n \\"ServiceManagedInfos\\": [\\n {\\n \\"Action\\": \\"Update\\",\\n \\"ChildType\\": \\"Listener\\",\\n \\"IsManaged\\": false\\n }\\n ]\\n }\\n ],\\n \\"Domain\\": \\"www.example.com\\",\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDomainsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <PageNumber>1</PageNumber>\\n <Domains>\\n <Accelerators>\\n <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>\\n <Name>Accelerator</Name>\\n </Accelerators>\\n <Domain>www.example.com</Domain>\\n <State>active</State>\\n </Domains>\\n</ListDomainsResponse>","errorExample":""}]', + 'title' => '查询域名与状态', + ], + 'GetInvalidDomainCount' => [ + 'summary' => '调用GetInvalidDomainCount接口获取违规域名总数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149767', + 'abilityTreeNodes' => [ + 'FEATUREgaN8JEXK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回请求列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'InvalidDomainCount' => [ + 'description' => '违规域名个数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"InvalidDomainCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<GetInvalidDomainCountResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <InvalidDomainCount>1</InvalidDomainCount>\\n</GetInvalidDomainCountResponse>","errorExample":""}]', + 'title' => '获取无效域名总数', + ], + 'DeleteDomainAcceleratorRelation' => [ + 'summary' => '调用DeleteDomainAcceleratorRelation接口删除加速域名的配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149754', + 'abilityTreeNodes' => [ + 'FEATUREgaN8JEXK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待解除关联的全球加速实例ID。最多支持输入50个全球加速ID。'."\n" + ."\n" + .'为空时默认删除指定加速域名下所有关联关系。', + 'type' => 'array', + 'items' => [ + 'description' => '待解除关联的全球加速实例ID。最多支持输入50个全球加速ID。'."\n" + ."\n" + .'为空时默认删除指定加速域名下所有关联关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待解除关联的加速域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Domain', + 'errorMessage' => 'The domain %s is not exist.', + ], + [ + 'errorCode' => 'NotExist.DomainAcceleratorRelation', + 'errorMessage' => 'The relationship between %s and %s does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDomainAcceleratorRelationResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteDomainAcceleratorRelationResponse>","errorExample":""}]', + 'title' => '删除加速域名的配置', + 'description' => '**DeleteDomainAcceleratorRelation**接口不支持在同一个账号下并发删除加速域名与全球加速实例的关联关系。', + ], + 'CreateBasicAccelerator' => [ + 'summary' => '基础型全球加速实例依托阿里云优质的全球互联网带宽与高品质传输网络，为用户提供点到点的加速体验。基础型全球加速实例主要用于三层（IP协议）网络加速。您可以通过调用CreateBasicAccelerator接口创建一个基础型全球加速实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'title' => '购买时长(默认值：1)', + 'description' => '购买时长。'."\n" + ."\n" + .'- 当**PricingCycle**取值**Month**时，**Duration**取值范围为**1**~**9**。'."\n" + ."\n" + .'- 当**PricingCycle**取值**Year**时，**Duration**取值范围为**1**~**3**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'title' => '时长单位(默认值：Month)', + 'description' => '计费周期。取值：'."\n" + ."\n" + .'- **Month**：按月计费。'."\n" + ."\n" + .'- **Year**：按年计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + 'default' => 'Month', + 'enum' => [ + 'Year', + 'Month', + 'Day', + 'Hour', + ], + ], + ], + [ + 'name' => 'BandwidthBillingType', + 'in' => 'query', + 'schema' => [ + 'description' => '带宽计费方式。取值：'."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + .'- **CDT**：按流量计费并由云数据传输（Cloud DataTransfer，简称CDT）统一结算。'."\n" + .'- **CDT95**：按95计费并由CDT统一结算。该带宽计费方式仅白名单用户可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'CDT', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'title' => '自动续费', + 'description' => '是否自动付费，取值：'."\n" + ."\n" + .'- **false**（默认值）：不开启自动付费，生成订单后需要到订单中心完成支付。'."\n" + ."\n" + .'- **true**：开启自动付费，自动支付订单。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'title' => '自动使用优惠券', + 'description' => '是否使用优惠券自动支付账单。取值：'."\n" + ."\n" + .'- **true**：使用。'."\n" + ."\n" + .'- **false**（默认值）：不使用。'."\n" + ."\n" + .'> 仅**AutoPay**为**true**时，该项才生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PromotionOptionNo', + 'in' => 'query', + 'schema' => [ + 'title' => '代金券号码', + 'description' => '优惠券号码。'."\n" + .'> 仅国际站涉及该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '50003298014****', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'title' => '自动续费', + 'description' => '是否开启自动续费。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**（默认值）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewDuration', + 'in' => 'query', + 'schema' => [ + 'title' => '续费周期', + 'description' => '自动续费时长。单位：月。'."\n" + ."\n" + .'取值范围：**1**~**12**。默认值：**1**。'."\n" + ."\n" + .'> 仅**AutoRenew**的为**true**时，该项才生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例所属资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxshhcsn****', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型。取值：'."\n" + .'- **PREPAY（默认值）**：代表预付费，即包年包月方式付费。'."\n" + .'- **POSTPAY**：代表后付费，即按使用时长方式付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAY', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '基础型全球加速实例的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '基础型全球加速实例的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'您最多可输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '基础型全球加速实例的标签值。一旦输入该值，不可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'您最多可输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'OrderId' => [ + 'title' => '订单Id', + 'description' => '订单ID。'."\n" + ."\n" + .'当ChargeType（付费类型）取值为 PREPAY（预付费）时，返回该参数。'."\n" + ."\n" + .'如果**AutoPay**取值为**false**，即未开启自动支付账单时，请前往<props="china">[订单中心](https://usercenter2.aliyun.com/order/list)</props>'."\n" + .'<props="intl">[订单中心](https://usercenter2-intl.aliyun.com/order/list)</props>完成支付。', + 'type' => 'string', + 'example' => '2082574365', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例ID', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"OrderId\\": \\"2082574365\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicAcceleratorResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <OrderId>2082574365</OrderId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n</CreateBasicAcceleratorResponse>","errorExample":""}]', + 'title' => '创建基础型全球加速实例', + 'description' => '**CreateBasicAccelerator**接口属于异步接口，即系统会先返回一个基础型全球加速实例ID，但基础型全球加速实例并未创建完成，系统后台的创建任务仍在进行。您可以调用[GetBasicAccelerator](~~353188~~)或[ListBasicAccelerators](~~353189~~)查询基础型全球加速实例的状态：'."\n" + ."\n" + .'- 当基础型全球加速实例处于**init**状态时，表示基础型全球加速实例正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .'- 当基础型全球加速实例处于**active**状态时，表示基础型全球加速实例创建完成。', + ], + 'UpdateBasicAccelerator' => [ + 'summary' => '调用UpdateBasicAccelerator接口修改基础型全球加速实例的名称与描述信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例名称', + 'description' => '基础型全球加速实例的名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicAccelerator', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例描述', + 'description' => '基础型全球加速实例的描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicAccelerator', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBasicAcceleratorResponse>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n</UpdateBasicAcceleratorResponse>","errorExample":""}]', + 'title' => '修改基础型全球加速实例', + ], + 'GetBasicAccelerator' => [ + 'summary' => '调用GetBasicAccelerator接口查询指定的基础型全球加速实例的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '要查询的基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '全球加速实例描述', + 'description' => '基础型全球加速实例的描述信息。', + 'type' => 'string', + 'example' => 'BasicAccelerator', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F591955F-5CB5-4CCE-A75D-17CF2085CE22', + ], + 'InstanceChargeType' => [ + 'title' => '全球加速实例收费类型', + 'description' => '基础型全球加速实例计费方式。仅支持返回**PREPAY**（包年包月）。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'CreateTime' => [ + 'title' => '全球加速实例创建时间', + 'description' => '基础型全球加速实例创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637734547', + ], + 'CrossDomainBandwidthPackage' => [ + 'title' => '绑定的跨境带宽包', + 'description' => '全球加速实例绑定的跨地域加速包的详情。'."\n" + ."\n" + .'仅国际站支持返回该数组。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'title' => '跨境带宽包带宽', + 'description' => '跨地域加速带宽包的带宽值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'InstanceId' => [ + 'title' => '跨境带宽包Id', + 'description' => '跨地域加速带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'Name' => [ + 'title' => '全球加速实例名称', + 'description' => '基础型全球加速实例名称。', + 'type' => 'string', + 'example' => 'BasicAccelerator', + ], + 'BasicBandwidthPackage' => [ + 'title' => '绑定的基础带宽包', + 'description' => '基础型全球加速实例绑定的基础带宽包的详情。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'title' => '基础带宽包带宽', + 'description' => '基础带宽包的带宽值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BandwidthType' => [ + 'title' => '基础带宽包类型', + 'description' => '基础带宽包的带宽类型。'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'InstanceId' => [ + 'title' => '基础带宽包Id', + 'description' => '基础带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'State' => [ + 'title' => '实例状态', + 'description' => '基础型全球加速实例的状态。'."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'ExpiredTime' => [ + 'title' => '到期时间', + 'description' => '基础型全球加速实例到期时间戳。'."\n" + ."\n" + .'Unix时间戳格式，单位为秒，表示从1970-01-01 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640326547', + ], + 'CenId' => [ + 'title' => '使用的云企业网Id', + 'description' => '基础型全球加速实例绑定的云企业网实例ID。', + 'type' => 'string', + 'example' => 'cen-hjkduu767hc****', + ], + 'RegionId' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'BasicEndpointGroupId' => [ + 'title' => '全球加速实例下车点Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'BasicIpSetId' => [ + 'title' => '全球加速实例上车点Id', + 'description' => '基础型全球加速实例的加速地域ID。', + 'type' => 'string', + 'example' => 'ips-bp11ilwqjdkjeg9r7****', + ], + 'BandwidthBillingType' => [ + 'title' => '带宽计费类型', + 'description' => '带宽计费方式。'."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + .'- **CDT**：按流量计费并由云数据传输（Cloud DataTransfer，简称CDT）统一结算。'."\n" + .'- **CDT95**：按95计费并由CDT统一结算。该带宽计费方式仅白名单用户可用。', + 'type' => 'string', + 'example' => 'CDT', + ], + 'CrossPrivateState' => [ + 'title' => '跨境开关状态', + 'description' => '是否开启了跨地域带宽跨境。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'string', + 'example' => 'false', + ], + 'CrossBorderStatus' => [ + 'description' => '基础型全球加速实例是否开启跨境线路功能。取值：'."\n" + ."\n" + .'- **true**：开启跨境线路功能，支持加速跨境线路。'."\n" + ."\n" + .'- **false**：关闭跨境线路功能，不支持加速跨境线路。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => '基础型全球加速实例所属资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzrnd67gq****', + ], + 'Tags' => [ + 'description' => '基础型全球加速实例的标签。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的标签。'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '基础型全球加速实例的标签键。', + 'type' => 'string', + 'example' => 'tag-key', + ], + 'Value' => [ + 'description' => '基础型全球加速实例的标签值。', + 'type' => 'string', + 'example' => 'tag-value', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Description\\": \\"BasicAccelerator\\",\\n \\"RequestId\\": \\"F591955F-5CB5-4CCE-A75D-17CF2085CE22\\",\\n \\"InstanceChargeType\\": \\"PREPAY\\",\\n \\"CreateTime\\": 1637734547,\\n \\"CrossDomainBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"Name\\": \\"BasicAccelerator\\",\\n \\"BasicBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"State\\": \\"active\\",\\n \\"ExpiredTime\\": 1640326547,\\n \\"CenId\\": \\"cen-hjkduu767hc****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"BasicEndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"BasicIpSetId\\": \\"ips-bp11ilwqjdkjeg9r7****\\",\\n \\"BandwidthBillingType\\": \\"CDT\\",\\n \\"CrossPrivateState\\": \\"false\\",\\n \\"CrossBorderStatus\\": false,\\n \\"ResourceGroupId\\": \\"rg-aekzrnd67gq****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag-key\\",\\n \\"Value\\": \\"tag-value\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetBasicAcceleratorResponse>\\n <Description>BasicAccelerator</Description>\\n <RequestId>F591955F-5CB5-4CCE-A75D-17CF2085CE22</RequestId>\\n <InstanceChargeType>PREPAY</InstanceChargeType>\\n <CreateTime>1637734547</CreateTime>\\n <CrossDomainBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </CrossDomainBandwidthPackage>\\n <Name>BasicAccelerator</Name>\\n <BasicBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <BandwidthType>Basic</BandwidthType>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </BasicBandwidthPackage>\\n <State>active</State>\\n <ExpiredTime>1640326547</ExpiredTime>\\n <CenId>cen-hjkduu767hc****</CenId>\\n <RegionId>cn-hangzhou</RegionId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <BasicEndpointGroupId>epg-bp1dmlohjjz4kqaun****</BasicEndpointGroupId>\\n <BasicIpSetId>ips-bp11ilwqjdkjeg9r7****</BasicIpSetId>\\n <BandwidthBillingType>CDT</BandwidthBillingType>\\n <CrossPrivateState>false</CrossPrivateState>\\n <ResourceGroupId>rg-aekzrnd67gq****</ResourceGroupId>\\n <Tags>\\n <Key>tag-key</Key>\\n <Value>tag-value</Value>\\n </Tags>\\n</GetBasicAcceleratorResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例的信息', + ], + 'ListBasicAccelerators' => [ + 'summary' => '调用ListBasicAccelerators接口查询基础型全球加速实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => '列表的页码。默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页查询时每页的行数。最大值：**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例状态', + 'description' => '基础型全球加速实例的状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例所属资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzrnd67gq****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '基础型全球加速实例的标签。'."\n" + ."\n" + .'您最多可输入20个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的标签。'."\n" + ."\n" + .'您最多可输入20个标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '基础型全球加速实例的标签键。一旦输入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'您最多可输入20个标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Keytest', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '基础型全球加速实例的标签值。一旦输入该值，不可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'您最多可输入20个标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Valuetest', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '全球加速实例总数', + 'description' => '基础型全球加速实例总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页大小', + 'description' => '分页查询时每页的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + 'Accelerators' => [ + 'title' => '全球加速实例列表', + 'description' => '基础型全球加速实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '全球加速实例类型', + 'description' => '无效参数。', + 'type' => 'string', + 'example' => 'None', + ], + 'State' => [ + 'title' => '全球加速实例状态', + 'description' => '基础型全球加速实例的状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **configuring**：配置中。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unbinding**：解绑中。'."\n" + ."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'- **finacialLocked**：欠费锁定。', + 'type' => 'string', + 'example' => 'active', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '基础型全球加速实例创建时间戳。'."\n" + ."\n" + .'Unix时间戳格式，单位为秒，表示从1970-01-01 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637734547', + ], + 'BasicBandwidthPackage' => [ + 'title' => '绑定的基础带宽包', + 'description' => '基础型全球加速实例绑定的基础带宽包的详情。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'title' => '基础带宽包带宽', + 'description' => '基础带宽包的带宽值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BandwidthType' => [ + 'title' => '基础带宽包类型', + 'description' => '基础带宽包的带宽类型。'."\n" + ."\n" + .'- **Basic**：标准加速带宽。'."\n" + ."\n" + .'- **Enhanced**：增强加速带宽。'."\n" + ."\n" + .'- **Advanced**：精品加速带宽。', + 'type' => 'string', + 'example' => 'Basic', + ], + 'InstanceId' => [ + 'title' => '基础带宽包Id', + 'description' => '基础带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'RegionId' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceChargeType' => [ + 'title' => '全球加速实例计费类型', + 'description' => '基础型全球加速实例计费方式。仅支持返回**PREPAY**（包年包月）。', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'Description' => [ + 'title' => '全球加速实例描述', + 'description' => '基础型全球加速实例的描述信息。', + 'type' => 'string', + 'example' => 'BasicAccelerator', + ], + 'ExpiredTime' => [ + 'title' => '到期时间', + 'description' => '基础性全球加速实例到期时间戳。'."\n" + ."\n" + .'Unix时间戳格式，单位为秒，表示从1970-01-01 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640326547', + ], + 'Name' => [ + 'title' => '全球加速实例名称', + 'description' => '基础型全球加速实例名称。', + 'type' => 'string', + 'example' => 'BasicAccelerator', + ], + 'CrossDomainBandwidthPackage' => [ + 'title' => '绑定的跨境带宽包', + 'description' => '全球加速实例绑定的跨地域加速包的详情。'."\n" + ."\n" + .'仅国际站支持返回该数组。', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'title' => '跨境带宽包带宽', + 'description' => '跨地域加速带宽包的带宽值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'InstanceId' => [ + 'title' => '跨境带宽包Id', + 'description' => '跨地域加速带宽包的实例ID。', + 'type' => 'string', + 'example' => 'gbwp-bp1d8xk8bg139j0fw****', + ], + ], + ], + 'BasicEndpointGroupId' => [ + 'title' => '全球加速实例下车点Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'BasicIpSetId' => [ + 'title' => '全球加速实例上车点Id', + 'description' => '基础型全球加速实例的加速地域ID。', + 'type' => 'string', + 'example' => 'ips-bp11ilwqjdkjeg9r7****', + ], + 'BandwidthBillingType' => [ + 'title' => '带宽计费类型', + 'description' => '带宽计费方式。'."\n" + .'- **BandwidthPackage**：按带宽包计费。'."\n" + .'- **CDT**：按流量计费并由云数据传输（Cloud DataTransfer，简称CDT）统一结算。'."\n" + .'- **CDT95**：按95计费并由CDT统一结算。该带宽计费方式仅白名单用户可用。', + 'type' => 'string', + 'example' => 'BandwidthPackage', + ], + 'ResourceGroupId' => [ + 'description' => '基础型全球加速实例所属资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekzrnd67gq****', + ], + 'Tags' => [ + 'description' => '基础型全球加速实例的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '基础型全球加速实例的标签键。', + 'type' => 'string', + 'example' => 'Keytest', + ], + 'Value' => [ + 'description' => '基础型全球加速实例的标签值。', + 'type' => 'string', + 'example' => 'Valuetest', + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + 'CrossBorderStatus' => [ + 'description' => '基础全球加速实例是否开启跨境线路功能。取值：'."\n" + ."\n" + .'- **true**：开启跨境线路功能，可以加速跨境线路。'."\n" + ."\n" + .'- **false**：关闭跨境线路功能，不可以加速跨境线路。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '页码', + 'description' => '列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"Accelerators\\": [\\n {\\n \\"Type\\": \\"None\\",\\n \\"State\\": \\"active\\",\\n \\"CreateTime\\": 1637734547,\\n \\"BasicBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"BandwidthType\\": \\"Basic\\",\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceChargeType\\": \\"PREPAY\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"Description\\": \\"BasicAccelerator\\",\\n \\"ExpiredTime\\": 1640326547,\\n \\"Name\\": \\"BasicAccelerator\\",\\n \\"CrossDomainBandwidthPackage\\": {\\n \\"Bandwidth\\": 2,\\n \\"InstanceId\\": \\"gbwp-bp1d8xk8bg139j0fw****\\"\\n },\\n \\"BasicEndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"BasicIpSetId\\": \\"ips-bp11ilwqjdkjeg9r7****\\",\\n \\"BandwidthBillingType\\": \\"BandwidthPackage\\",\\n \\"ResourceGroupId\\": \\"rg-aekzrnd67gq****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Keytest\\",\\n \\"Value\\": \\"Valuetest\\"\\n }\\n ],\\n \\"CrossBorderStatus\\": false\\n }\\n ],\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListBasicAcceleratorsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <Accelerators>\\n <Type>None</Type>\\n <State>active</State>\\n <CreateTime>1637734547</CreateTime>\\n <BasicBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <BandwidthType>Basic</BandwidthType>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </BasicBandwidthPackage>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceChargeType>PREPAY</InstanceChargeType>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <Description>BasicAccelerator</Description>\\n <ExpiredTime>1640326547</ExpiredTime>\\n <Name>BasicAccelerator</Name>\\n <CrossDomainBandwidthPackage>\\n <Bandwidth>2</Bandwidth>\\n <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>\\n </CrossDomainBandwidthPackage>\\n <BasicEndpointGroupId>epg-bp1dmlohjjz4kqaun****</BasicEndpointGroupId>\\n <BasicIpSetId>ips-bp11ilwqjdkjeg9r7****</BasicIpSetId>\\n <BandwidthBillingType>BandwidthPackage</BandwidthBillingType>\\n <ResourceGroupId>rg-aekzrnd67gq****</ResourceGroupId>\\n <Tags>\\n <Key>Keytest</Key>\\n <Value>Valuetest</Value>\\n </Tags>\\n <CrossBorderStatus>false</CrossBorderStatus>\\n </Accelerators>\\n <PageNumber>1</PageNumber>\\n</ListBasicAcceleratorsResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例列表', + ], + 'DeleteBasicAccelerator' => [ + 'summary' => '调用DeleteBasicAccelerator接口删除指定的基础型全球加速实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54B48E3D-DF70-471B-AA93-08E683A1B45', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'BindExist.Accelerator', + 'errorMessage' => 'The accelerated instance is already bound to a bandwidth package.', + ], + [ + 'errorCode' => 'Exist.IpSet', + 'errorMessage' => 'The IpSet still exists.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"54B48E3D-DF70-471B-AA93-08E683A1B45\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicAcceleratorResponse>\\n <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n</DeleteBasicAcceleratorResponse>","errorExample":""}]', + 'title' => '删除基础型全球加速实例', + 'description' => '- 不支持删除预付费（包年包月）基础型全球加速实例。您可以前往<props="china">[退订管理](https://usercenter2.aliyun.com/refund/refund)</props><props="intl">[退订管理](https://usercenter2-intl.aliyun.com/refund/refund)</props>页面进行退订。退订前，请确保基础型全球加速实例已不存在加速区域、终端节点组配置，且未绑定带宽包。'."\n" + .' - 删除加速区域，请参见[DeleteBasicIpSet](~~2253388~~)。'."\n" + .' - 删除终端节点组，请参见[DeleteBasicEndpointGroup](~~2253399~~)。'."\n" + .' - 解绑带宽包与基础型全球加速实例，请参见[BandwidthPackageRemoveAccelerator](~~153240~~)。'."\n" + .'- 调用本接口删除后付费（按量付费）基础型全球加速实例前，请先确保已完成数据迁移，且已删除该实例下的加速区域及终端节点组配置。'."\n" + .' - 删除加速区域，请参见[DeleteBasicIpSet](~~2253388~~)。'."\n" + .' - 删除终端节点组，请参见[DeleteBasicEndpointGroup](~~2253399~~)。'."\n" + .'- **DeleteBasicAccelerator**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例并未删除完成，系统后台的删除任务仍在进行。您可以调用[GetBasicAccelerator](~~353188~~)查询基础型全球加速实例的状态：'."\n" + .' - 当基础型全球加速实例处于**deleting**状态时，表示基础型全球加速实例正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该基础型全球加速实例时，表示基础型全球加速实例删除完成。', + ], + 'CreateBasicIpSet' => [ + 'summary' => '调用CreateBasicIpSet接口创建基础型全球加速实例的加速地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'AccelerateRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速地域Id', + 'description' => '要加速的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListAvailableBusiRegions](~~261190~~)接口获取指定的全球加速实例可用的加速地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'IspType', + 'in' => 'query', + 'schema' => [ + 'title' => '公网质量类型', + 'description' => '加速地域公网线路类型。取值：'."\n" + .'- **BGP**（默认值）：BGP（多线）线路'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路'."\n" + ."\n" + .'如果您是单线带宽的白名单用户，您还可以选择以下类型：'."\n" + .'- **ChinaTelecom**：中国电信（单线）'."\n" + .'- **ChinaUnicom**：中国联通（单线）'."\n" + .'- **ChinaMobile**：中国移动（单线）'."\n" + .'- **ChinaTelecom_L2**：中国电信（单线）\\_L2'."\n" + .'- **ChinaUnicom_L2**：中国联通（单线）\\_L2'."\n" + .'- **ChinaMobile_L2**：中国移动（单线）\\_L2'."\n" + .'> - 带宽计费方式为**按流量**的基础型全球加速实例需要配置该项。'."\n" + .'> - 基础型全球加速实例的加速地域为中国香港，且绑定了精品加速带宽类型的基础带宽包时，默认为BGP（多线）\\_精品线路。'."\n" + .'> - 加速地域不同，支持的单线线路类型不同。', + 'type' => 'string', + 'required' => false, + 'example' => 'BGP', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '加速地域带宽，单位：**Mbps**。'."\n" + ."\n" + .'加速地域支持分配的最小带宽为 2Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'IpSetId' => [ + 'title' => '加速地域接入点Id', + 'description' => '基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicIpSetResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n</CreateBasicIpSetResponse>","errorExample":""}]', + 'title' => '创建基础型全球加速实例的加速地域', + 'description' => '调用本接口，请注意以下事项：'."\n" + ."\n" + .'- 基础型全球加速实例仅支持添加一个加速地域，且仅支持IPv4地址协议接入。'."\n" + .'- **CreateBasicIpSet**接口属于异步接口，即系统会先返回一个加速地域实例ID，但加速地域未创建完成，系统后台的创建任务仍在进行。您可以调用[GetBasicIpSet](~~362987~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**init**状态时，表示加速地域正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速地域处于**active**状态时，表示加速地域创建完成。'."\n" + .'- **CreateBasicIpSet**接口不支持在同一个基础型全球加速实例内并发创建加速地域。', + ], + 'UpdateBasicIpSet' => [ + 'summary' => '调用UpdateBasicIpSet接口修改基础型全球加速实例的接入地域带宽。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155456', + 'abilityTreeNodes' => [ + 'FEATUREgaQQ43JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例的接入地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例的接入地域带宽。单位：Mbps。、'."\n" + ."\n" + .'加速地域支持分配的最小带宽为 2Mbps。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D2BFF54-6AF2-4679-88C4-2F2E187F16CB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'StateError.IpSet', + 'errorMessage' => 'The state of IpSet is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'GreaterThanGa.IpSetBandwidth', + 'errorMessage' => 'The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D2BFF54-6AF2-4679-88C4-2F2E187F16CB\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBasicIpSetResponse>\\n <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>\\n</UpdateBasicIpSetResponse>","errorExample":""}]', + 'title' => '修改基础型全球加速实例的加速地域带宽', + 'description' => '调用本接口，请注意以下事项：'."\n" + .'- 仅带宽计费方式为**按流量**的基础型全球加速实例支持修改加速地域的带宽。'."\n" + .'- **UpdateBasicIpSet**接口属于异步接口，即系统会先返回一个请求ID，但接入地域带宽未修改完成，系统后台的修改任务仍在进行。您可以调用[GetBasicIpSet](~~362987~~)查询接入地域带宽的修改状态：'."\n" + .' - 当接入地域处于**updating**状态时，表示接入地域带宽正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当接入地域处于**active**状态时，表示接入地域带宽修改完成。'."\n" + .'- **UpdateBasicIpSet**接口不支持在同一个基础型全球加速实例内并发修改接入地域带宽。', + ], + 'GetBasicIpSet' => [ + 'summary' => '调用GetBasicIpSet接口查询指定基础型全球加速实例的加速地域信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速接入点Id', + 'description' => '基础型全球加速实例的加速地域实例ID。'."\n" + ."\n" + .'您可以调用[GetBasicAccelerator](~~2253380~~)查询加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D2BFF54-6AF2-4679-88C4-2F2E187F16CB', + ], + 'AccelerateRegionId' => [ + 'title' => '加速地域Id', + 'description' => '基础型全球加速实例的加速地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Bandwidth' => [ + 'title' => '带宽值', + 'description' => '基础型全球加速实例的加速地域带宽。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IpSetId' => [ + 'title' => '加速接入点id', + 'description' => '基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11ilwqjdkjeg9r7****', + ], + 'IpAddress' => [ + 'title' => '加速接入点IP地址', + 'description' => '加速IP。', + 'type' => 'string', + 'example' => '118.31.XX.XX', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'IpVersion' => [ + 'title' => '加速接入点地址类型', + 'description' => '加速IP地址协议版本。取值：**IPv4**。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'State' => [ + 'title' => '加速接入点状态', + 'description' => '基础型全球加速实例的加速地域状态。取值：'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：运行中。'."\n" + ."\n" + .'- **updating**：配置中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'IspType' => [ + 'title' => '公网质量类型', + 'description' => '加速地域公网线路类型。取值：'."\n" + .'- **BGP**（默认值）：BGP（多线）线路'."\n" + .'- **BGP_PRO**：BGP（多线）\\_精品线路'."\n" + ."\n" + .'如果您是单线带宽的白名单用户，您还可能返回以下类型：'."\n" + .'- **ChinaTelecom**：中国电信（单线）'."\n" + .'- **ChinaUnicom**：中国联通（单线） '."\n" + .'- **ChinaMobile**：中国移动（单线）'."\n" + .'- **ChinaTelecom_L2**：中国电信（单线）_L2'."\n" + .'- **ChinaUnicom_L2**：中国联通（单线）_L2'."\n" + .'- **ChinaMobile_L2**：中国移动（单线）_L2', + 'type' => 'string', + 'example' => 'BGP', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D2BFF54-6AF2-4679-88C4-2F2E187F16CB\\",\\n \\"AccelerateRegionId\\": \\"cn-hangzhou\\",\\n \\"Bandwidth\\": 2,\\n \\"IpSetId\\": \\"ips-bp11ilwqjdkjeg9r7****\\",\\n \\"IpAddress\\": \\"118.31.XX.XX\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"State\\": \\"active\\",\\n \\"IspType\\": \\"BGP\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBasicIpSetResponse>\\n <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>\\n <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>\\n <Bandwidth>2</Bandwidth>\\n <IpSetId>ips-bp11ilwqjdkjeg9r7****</IpSetId>\\n <IpAddress>118.31.XX.XX</IpAddress>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <IpVersion>IPv4</IpVersion>\\n <State>active</State>\\n</GetBasicIpSetResponse>","errorExample":""}]', + 'title' => '查询指定基础型全球加速实例的加速地域信息', + ], + 'DeleteBasicIpSet' => [ + 'summary' => '调用DeleteBasicIpSet接口删除基础型全球加速实例的加速地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速接入点Id', + 'description' => '基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D2BFF54-6AF2-4679-88C4-2F2E187F16CB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'StateError.IpSet', + 'errorMessage' => 'The state of IpSet is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'ExplicitDeny', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D2BFF54-6AF2-4679-88C4-2F2E187F16CB\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicIpSetResponse>\\n <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>\\n</DeleteBasicIpSetResponse>","errorExample":""}]', + 'title' => '删除基础性全球加速实例的加速地域', + 'description' => '- 存在绑定状态的加速IP，加速地域不可删除。您可以调用[DeleteBasicAccelerateIpEndpointRelation](~~2253413~~)解除加速IP与终端节点的绑定关系。'."\n" + .'- ** DeleteBasicIpSet**接口属于异步接口，即系统会先返回一个请求ID，但加速地域并未删除完成，系统后台的删除任务仍在进行。您可以调用[GetBasicIpSet](~~362987~~)查询加速地域的状态：'."\n" + .' - 当加速地域处于**deleting**状态时，表示加速地域正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该加速地域时，表示加速地域删除完成。'."\n" + .'- ** DeleteBasicIpSet**接口不支持在同一个基础型全球加速实例内并发删除加速地域。', + ], + 'CreateBasicAccelerateIp' => [ + 'summary' => '调用CreateBasicAccelerateIp接口为基础型全球加速实例创建加速IP。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速地域Id', + 'description' => '基础型全球加速实例的加速地域实例ID。'."\n" + ."\n" + .'您可以调用[GetBasicAccelerator](~~2253380~~)查询加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'title' => '加速实例id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'IpSetId' => [ + 'title' => '加速地域接入点Id', + 'description' => '基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'AccelerateIpId' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'AccelerateIpAddress' => [ + 'title' => '加速Ip', + 'description' => '基础型全球加速实例的加速IP。'."\n" + ."\n" + .'> 该参数暂未启用。', + 'type' => 'string', + 'example' => '116.132.XX.XX', + ], + 'State' => [ + 'title' => '加速Ip状态', + 'description' => '加速IP的状态。'."\n" + ."\n" + .'**init**：初始化。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state configuring is illegal', + ], + [ + 'errorCode' => 'NotExist.IpSet', + 'errorMessage' => 'The IpSet does not exist.', + ], + [ + 'errorCode' => 'NotActive.IpSet', + 'errorMessage' => 'The state of IpSet is not active.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"AccelerateIpAddress\\": \\"116.132.XX.XX\\",\\n \\"State\\": \\"null\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicAccelerateIpResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <AccelerateIpAddress>116.132.XX.XX</AccelerateIpAddress>\\n <State>null</State>\\n</CreateBasicAccelerateIpResponse>","errorExample":""}]', + 'title' => '为基础型全球加速实例创建加速IP', + 'description' => '- **CreateBasicAccelerateIp**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例加速IP未创建完成，系统后台的创建任务仍在进行。您可以调用[GetBasicAccelerateIp](~~466794~~)查询加速IP的状态：'."\n" + .' - 当不返回状态信息时，表示加速IP正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速IP处于**active**状态时，表示加速IP创建完成。'."\n" + .'- **CreateBasicAccelerateIp**接口不支持在同一个基础型全球加速实例内并发创建加速IP。', + ], + 'GetBasicAccelerateIp' => [ + 'summary' => '调用GetBasicAccelerateIp接口查询基础型全球加速实例下指定加速IP的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版全球加速Ip实例Id', + 'description' => '待查询的基础型全球加速实例加速IP实例ID。'."\n" + ."\n" + .'您可以调用[ListBasicAccelerateIps](~~2253393~~)查询加速IP实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gaip-bp1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '加速IP所属的基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'IpSetId' => [ + 'title' => '加速地域接入点Id', + 'description' => '加速IP所属的基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'AccelerateIpId' => [ + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'AccelerateIpAddress' => [ + 'description' => '基础型全球加速实例的加速IP。', + 'type' => 'string', + 'example' => '116.132.XX.XX', + ], + 'State' => [ + 'description' => '加速IP的状态。'."\n" + .'- **active**：可用。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **bound**：已绑定。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'> 当加速IP处于创建中时，不返回该参数。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"AccelerateIpAddress\\": \\"116.132.XX.XX\\",\\n \\"State\\": \\"active\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBasicAccelerateIpResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <AccelerateIpAddress>116.132.XX.XX</AccelerateIpAddress>\\n <State>active</State>\\n</GetBasicAccelerateIpResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例下指定加速IP的信息', + ], + 'GetBasicAccelerateIpIdleCount' => [ + 'summary' => '调用GetBasicAccelerateIpIdleCount接口查询基础型全球加速实例的闲置加速IP数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版加速区Id', + 'description' => '待查询的基础型全球加速实例的加速地域实例ID。'."\n" + ."\n" + .'您可以调用[GetBasicAccelerator](~~2253380~~)查询加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数，即闲置加速IP的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<GetBasicAccelerateIpIdleCountResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n</GetBasicAccelerateIpIdleCountResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例的闲置加速IP数量', + ], + 'ListBasicAccelerateIps' => [ + 'summary' => '调用ListBasicAccelerateIps接口查询基础型全球加速实例加速地域下的加速IP信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpSetId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速区Id', + 'description' => '基础型全球加速实例的加速地域实例ID。'."\n" + ."\n" + .'您可以调用[GetBasicAccelerator](~~2253380~~)查询加速地域实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + ], + [ + 'name' => 'AccelerateIpAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip', + 'description' => '基础型全球加速实例的加速IP。', + 'type' => 'string', + 'required' => false, + 'example' => '116.132.XX.XX', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gaip-bp1****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'MaxResults' => [ + 'description' => '分批次查询时每次显示的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AccelerateIps' => [ + 'description' => '基础型全球加速实例的加速IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的加速IP列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'IpSetId' => [ + 'description' => '基础型全球加速实例的加速地域实例ID。', + 'type' => 'string', + 'example' => 'ips-bp11r5jb8ogp122xl****', + ], + 'AccelerateIpId' => [ + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'AccelerateIpAddress' => [ + 'description' => '基础型全球加速实例的加速IP。', + 'type' => 'string', + 'example' => '116.132.XX.XX', + ], + 'State' => [ + 'description' => '加速IP的状态。'."\n" + .'- **active**：可用。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **bound**：已绑定。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **deleting**：删除中。'."\n" + ."\n" + .'> 当加速IP处于创建中时，不返回该参数。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 1,\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": 10,\\n \\"AccelerateIps\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"IpSetId\\": \\"ips-bp11r5jb8ogp122xl****\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"AccelerateIpAddress\\": \\"116.132.XX.XX\\",\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListBasicAccelerateIpsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <AccelerateIps>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <AccelerateIpAddress>116.132.XX.XX</AccelerateIpAddress>\\n <State>active</State>\\n </AccelerateIps>\\n</ListBasicAccelerateIpsResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例加速地域下的加速IP信息', + ], + 'DeleteBasicAccelerateIp' => [ + 'summary' => '调用DeleteBasicAccelerateIp接口删除基础型全球加速实例的加速IP。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '158418', + 'abilityTreeNodes' => [ + 'FEATUREgaLMO5F2', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版全球加速实例Id', + 'description' => '待删除的基础型全球加速实例加速IP的实例ID。'."\n" + ."\n" + .'您可以调用[ListBasicAccelerateIps](~~2253393~~)查询加速IP实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gaip-bp1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AccelerateIpId' => [ + 'title' => '加速地域接入点Id', + 'description' => '基础型全球加速实例加速IP的实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'No permissions.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicAccelerateIpResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n</DeleteBasicAccelerateIpResponse>","errorExample":""}]', + 'title' => '删除基础型全球加速实例的加速IP', + 'description' => '- **DeleteBasicAccelerateIp**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例加速IP未删除完成，系统后台的删除任务仍在进行。您可以调用[GetBasicAccelerateIp](~~466794~~)查询加速IP的状态：'."\n" + .' - 当加速IP处于**deleting**状态时，表示加速正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该加速IP时，表示加速IP删除完成。'."\n" + .'- **DeleteBasicAccelerateIp**接口不支持在同一个基础型全球加速实例内并发删除加速IP。', + ], + 'CreateBasicEndpointGroup' => [ + 'summary' => '调用CreateBasicEndpointGroup接口创建基础型全球加速实例的终端节点组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '基础型全球加速实例所在的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointGroupRegion', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组所在地域', + 'description' => '基础型全球加速实例的终端节点组所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListAvailableBusiRegions](~~2253223~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组名称', + 'description' => '基础型全球加速实例的终端节点组的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组描述', + 'description' => '基础型全球加速实例的终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicEndpointGroup', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。取值：'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENI', + ], + ], + [ + 'name' => 'EndpointAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'eni-bp1a05txelswuj8g****', + ], + ], + [ + 'name' => 'EndpointSubAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点辅助IP。', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当加速IP绑定到ECS辅助私网IP地址或ENI辅助私网IP时，需配置该参数。'."\n" + ."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**可以为主网卡的辅助私网IP，为空表示主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**可以为辅助网卡的辅助私网IP，为空表示辅助网卡的主私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Resource.QuotaFull', + 'errorMessage' => 'The resource quota is exceeded.', + ], + [ + 'errorCode' => 'NoPermission.EnableHealthCheck', + 'errorMessage' => 'You do not have permission to enable health check.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + [ + 'errorCode' => 'NotExist.BusinessRegion', + 'errorMessage' => 'The business region does not exist.', + ], + [ + 'errorCode' => 'NotExist.BasicBandwidthPackage', + 'errorMessage' => 'You must specify the basic bandwidth package.', + ], + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + [ + 'errorCode' => 'QuotaExceeded.EndpointGroup', + 'errorMessage' => 'The number of endpoint group exceeds the limit.', + ], + [ + 'errorCode' => 'EcsCannotBind.BasicEndpoint', + 'errorMessage' => 'The ECS instance has already been associated with another EIP.', + ], + [ + 'errorCode' => 'InvalidateRegion.BasicAccelerator', + 'errorMessage' => 'The region of the endpoint group and the acceleration region cannot be the same.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicEndpointGroupResponse>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</CreateBasicEndpointGroupResponse>","errorExample":""}]', + 'title' => '创建基础型全球加速实例的终端节点组', + 'description' => '- **CreateBasicEndpointGroup**接口属于异步接口，即系统会先返回一个终端节点组ID，但终端节点组未创建完成，系统后台的创建任务仍在进行。您可以调用[GetBasicEndpointGroup](~~362984~~)查询终端节点组的状态：'."\n" + .' - 当终端节点组处于**init**状态时，表示终端节点组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点组处于**active**状态时，表示终端节点组创建完成。'."\n" + .'- **CreateBasicEndpointGroup**接口不支持在同一个基础型全球加速实例内并发创建终端节点组。', + ], + 'UpdateBasicEndpointGroup' => [ + 'summary' => '调用UpdateBasicEndpointGroup接口修改基础型终端节点组配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组名称', + 'description' => '基础型全球加速实例的终端节点组的名称。'."\n" + ."\n" + .'名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'group1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组描述', + 'description' => '基础型全球加速实例的终端节点组描述信息。'."\n" + ."\n" + .'描述长度最大200字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'BasicEndpointGroup', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。取值：'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENI', + ], + ], + [ + 'name' => 'EndpointAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'eni-bp1a05txelswuj8g****', + ], + ], + [ + 'name' => 'EndpointSubAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点辅助IP。', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当加速IP绑定到ECS辅助私网IP地址或ENI辅助私网IP时，需配置该参数。'."\n" + ."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**可以为主网卡的辅助私网IP，为空表示主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**可以为辅助网卡的辅助私网IP，为空表示辅助网卡的主私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '修改基础型终端节点组配置信息', + 'description' => '- **UpdateBasicEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例的终端节点组配置信息并未修改完成，系统后台的修改任务仍在进行。后台通过删除原终端节点组并创建新的终端节点组来完成基础型全球加速实例终端节点组的修改，您可以调用[GetBasicAccelerator](~~353188~~)，通过查询基础型全球加速实例的状态，来确认终端节点组配置信息修改是否完成：'."\n" + ."\n" + .' - 当基础型全球加速实例处于**configuring**状态时，表示终端节点组配置信息正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + ."\n" + .' - 当基础型全球加速实例处于**active**状态时，表示终端节点组配置信息修改完成。'."\n" + ."\n" + .'- **UpdateBasicEndpointGroup**接口不支持在同一个基础型全球加速实例内并发修改终端节点组配置信息。', + ], + 'GetBasicEndpointGroup' => [ + 'summary' => '调用GetBasicEndpointGroup接口查询指定基础型全球加速实例的终端节点组信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'Name' => [ + 'title' => '终端节点组名称', + 'description' => '基础型全球加速实例的终端节点组的名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Description' => [ + 'title' => '终端节点组描述', + 'description' => '基础型全球加速实例的终端节点组描述信息。', + 'type' => 'string', + 'example' => 'BasicEndpointGroup', + ], + 'EndpointGroupRegion' => [ + 'title' => '终端节点组所在地域', + 'description' => '基础型全球加速实例的终端节点组所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'EndpointType' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'title' => '终端节点组地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'State' => [ + 'title' => '终端节点组状态', + 'description' => '基础型全球加速实例的终端节点组的状态。'."\n" + ."\n" + .'- **init**：初始化。'."\n" + ."\n" + .'- **active**：正常。'."\n" + ."\n" + .'- **updating**：更新中。'."\n" + ."\n" + .'- **deleting**：删除中。', + 'type' => 'string', + 'example' => 'active', + ], + 'EndpointSubAddress' => [ + 'title' => '终端节点辅助IP。', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"Name\\": \\"group1\\",\\n \\"Description\\": \\"BasicEndpointGroup\\",\\n \\"EndpointGroupRegion\\": \\"cn-shanghai\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"State\\": \\"active\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBasicEndpointGroupResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <Name>group1</Name>\\n <Description>BasicEndpointGroup</Description>\\n <EndpointGroupRegion>cn-shanghai</EndpointGroupRegion>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <State>active</State>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n</GetBasicEndpointGroupResponse>","errorExample":""}]', + 'title' => '查询指定基础型全球加速实例的终端节点组信息', + ], + 'DeleteBasicEndpointGroup' => [ + 'summary' => '调用DeleteBasicEndpointGroup接口删除基础型全球加速实例的终端节点组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.EndPointGroup', + 'errorMessage' => 'The endpoint group does not exist.', + ], + [ + 'errorCode' => 'StateError.EndPointGroup', + 'errorMessage' => 'The specified state of endpoint group is invalid.', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'The state of the accelerated instance is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbbiden.SubUser', + 'errorMessage' => 'You are not authorized to operate on the specified resource because your account was created by another user.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'The user is not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicEndpointGroupResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteBasicEndpointGroupResponse>","errorExample":""}]', + 'title' => '删除基础型全球加速实例的终端节点组', + 'description' => '删除终端节点组前，请注意：'."\n" + ."\n" + .'- 存在终端节点与加速IP绑定关系时，不支持删除终端节点组。您可以调用[DeleteBasicAccelerateIpEndpointRelation](~~2253413~~)解除加速IP与终端节点的绑定关系。'."\n" + .'- 当所有终端节点不再存在与加速IP的绑定关系时，可直接删除终端节点组，系统将同时删除该终端节点组下所有终端节点。'."\n" + .'- **DeleteBasicEndpointGroup**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例的终端节点组并未删除完成，系统后台的删除任务仍在进行。您可以调用[GetBasicEndpointGroup](~~362984~~)查询该终端节点组的状态：'."\n" + .' - 当终端节点组处于**deleting**状态时，表示终端节点组正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该终端节点组时，表示终端节点组删除完成。'."\n" + .'- **DeleteBasicEndpointGroup**接口不支持在同一个基础型全球加速实例内并发删除终端节点组。', + ], + 'CreateBasicEndpoint' => [ + 'summary' => '调用CreateBasicEndpoint接口为基础型全球加速实例创建终端节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组所在地域', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点名称', + 'description' => '基础型全球加速实例终端节点的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep01', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。取值：'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'ENI', + ], + ], + [ + 'name' => 'EndpointAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'eni-bp1a05txelswuj8g****', + ], + ], + [ + 'name' => 'EndpointSubAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点辅助IP。', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，需配置该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**可以为主网卡的辅助私网IP，为空表示主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**可以为辅助网卡的辅助私网IP，为空表示辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，该参数必填，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.XX.XX', + ], + ], + [ + 'name' => 'EndpointSubAddressType', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点辅助IP类型', + 'description' => '终端节点辅助地址的类型。取值：'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，需配置该参数。其中，终端节点类型为**NLB**时，仅支持**primary**类型。'."\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + ], + ], + [ + 'name' => 'EndpointZoneId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点可用区', + 'description' => '终端节点所在可用区ID。'."\n" + ."\n" + .'目前，仅当终端节点类型为**NLB**时，需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'EndpointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicEndpointResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n</CreateBasicEndpointResponse>","errorExample":""}]', + 'title' => '为基础型全球加速实例创建终端节点', + 'description' => '- **CreateBasicEndpoint**接口属于异步接口，即系统会先返回一个基础型全球加速实例终端节点ID，但终端节点未创建完成，系统后台的创建任务仍在进行。您可以调用[ListBasicEndpoints](~~466831~~)查询终端节点的状态： '."\n" + .' - 当终端节点状态为**init**时，表示终端节点正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当终端节点状态为**active**时，表示终端节点已创建完成。'."\n" + .'- **CreateBasicEndpoint**接口不支持在同一个基础型全球加速实例内并发创建终端节点。', + ], + 'CreateBasicEndpoints' => [ + 'summary' => '调用CreateBasicEndpoints接口为基础型全球加速实例批量创建终端节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'Endpoints', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '终端节点列表', + 'description' => '基础型全球加速实例的终端节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的终端节点列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '基础型全球加速实例终端节点的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep01', + ], + 'EndpointType' => [ + 'description' => '终端节点类型。取值：'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。'."\n" + ."\n" + .'> 该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'description' => '终端节点的地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，需配置该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**可以为主网卡的辅助私网IP，为空表示主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**可以为辅助网卡的辅助私网IP，为空表示辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，该参数必填，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.XX.XX', + ], + 'EndpointSubAddressType' => [ + 'description' => '终端节点辅助地址的类型。取值：'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，需配置该参数。其中，终端节点类型为**NLB**时，仅支持**primary**类型。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'primary', + ], + 'EndpointZoneId' => [ + 'description' => '终端节点所在可用区ID。'."\n" + ."\n" + .'目前，仅当终端节点类型为**NLB**时，需要输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'Endpoints' => [ + 'title' => '终端节点列表', + 'description' => '基础型全球加速实例的终端节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的终端节点列表。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'EndpointType' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'title' => '终端节点子地址', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'NotFound.ENIInstance', + 'errorMessage' => 'The ENI instance is not found.', + ], + [ + 'errorCode' => 'Invalidate.SlbAddressType', + 'errorMessage' => 'The SLB instance must be internal-facing.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"Endpoints\\": [\\n {\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <Endpoints>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n </Endpoints>\\n</CreateBasicEndpointsResponse>","errorExample":""}]', + 'title' => '为基础型全球加速实例批量创建终端节点', + 'description' => '- **CreateBasicEndpoints**接口属于异步接口，即系统会先返回一个请求ID，但终端节点未批量创建完成，系统后台的批量创建任务仍在进行。您可以调用[ListBasicEndpoints](~~466831~~)查询终端节点的状态： '."\n" + .' - 当存在终端节点状态为**init**时，表示终端节点批量创建任务未完成，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当所有终端节点状态为**active**时，表示终端节点已批量创建完成。'."\n" + .'- **CreateBasicEndpoints**接口不支持在同一个基础型全球加速实例内并发批量创建终端节点。', + ], + 'UpdateBasicEndpoint' => [ + 'summary' => '调用UpdateBasicEndpoint接口修改基础型全球加速实例的终端节点名称。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组所在地域', + 'description' => '待修改的基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '待修改的基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点名称', + 'description' => '基础型全球加速实例终端节点的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep01', + 'maxLength' => 128, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'EndpointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'Name' => [ + 'title' => '终端节点名称', + 'description' => '基础型全球加速实例终端节点的名称。', + 'type' => 'string', + 'example' => 'ep01', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"Name\\": \\"ep01\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBasicEndpointResponse>\\n <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <Name>ep01</Name>\\n</UpdateBasicEndpointResponse>","errorExample":""}]', + 'title' => '修改基础型全球加速实例的终端节点名称', + ], + 'GetBasicEndpoint' => [ + 'summary' => '调用GetBasicEndpoint接口查询基础型全球加速实例下指定终端节点的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '待查询的基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'title' => '全球加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'EndpointGroupId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'EndPointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'Name' => [ + 'title' => '终端节点名称', + 'description' => '基础型全球加速实例终端节点的名称。', + 'type' => 'string', + 'example' => 'ep01', + ], + 'EndpointType' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'title' => '终端节点子地址', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'EndpointSubAddressType' => [ + 'title' => '终端节点子地址类型', + 'description' => '终端节点辅助地址的类型。'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。其中，终端节点类型为**NLB**时，仅返回**primary**类型。', + 'type' => 'string', + 'example' => 'primary', + ], + 'EndpointZoneId' => [ + 'title' => '终端节点可用区', + 'description' => '终端节点所在可用区ID。'."\n" + ."\n" + .'目前，仅当终端节点类型为**NLB**时，返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'State' => [ + 'description' => '终端节点状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **updating**：配置中。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **bound**：已绑定。', + 'type' => 'string', + 'example' => 'active', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"EndPointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"Name\\": \\"ep01\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\",\\n \\"EndpointSubAddressType\\": \\"primary\\",\\n \\"EndpointZoneId\\": \\"cn-hangzhou-g\\",\\n \\"State\\": \\"active\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBasicEndpointResponse>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <EndPointId>ep-bp14sz7ftcwwjgrdm****</EndPointId>\\n <Name>ep01</Name>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n <EndpointSubAddressType>primary</EndpointSubAddressType>\\n <EndpointZoneId>cn-hangzhou-g</EndpointZoneId>\\n <State>active</State>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</GetBasicEndpointResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例下指定终端节点的信息', + ], + 'ListBasicEndpoints' => [ + 'summary' => '调用ListBasicEndpoints接口查询基础型全球加速实例的终端节点列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '待查询的基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'EndpointType', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点类型', + 'description' => '待查询的基础型全球加速实例终端节点类型。取值：'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENI', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '待查询的基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点名称', + 'description' => '待查询的基础型全球加速实例终端节点的名称。'."\n" + ."\n" + .'名称长度为1~128个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep01', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'string', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'MaxResults' => [ + 'description' => '分批次查询时每次显示的条目数。', + 'type' => 'string', + 'example' => '10', + ], + 'Endpoints' => [ + 'description' => '基础型全球加速实例终端节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例终端节点列表。', + 'type' => 'object', + 'properties' => [ + 'AcceleratorId' => [ + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'EndpointGroupId' => [ + 'description' => '基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + 'EndpointId' => [ + 'description' => '基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'Name' => [ + 'description' => '基础型全球加速实例终端节点的名称。', + 'type' => 'string', + 'example' => 'ep01', + ], + 'EndpointType' => [ + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'EndpointSubAddressType' => [ + 'description' => '终端节点的辅助地址类型。'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。其中，终端节点类型为**NLB**时，仅返回**primary**类型。', + 'type' => 'string', + 'example' => 'primary', + ], + 'EndpointZoneId' => [ + 'description' => '终端节点的可用区ID。'."\n" + ."\n" + .'目前，仅当终端节点类型为**NLB**时，返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'State' => [ + 'description' => '终端节点状态。'."\n" + .'- **init**：初始化。'."\n" + .'- **active**：可用。'."\n" + .'- **updating**：配置中。'."\n" + .'- **binding**：绑定中。'."\n" + .'- **unbinding**：解绑中。'."\n" + .'- **deleting**：删除中。'."\n" + .'- **bound**：已绑定。'."\n", + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"Endpoints\\": [\\n {\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"EndpointGroupId\\": \\"epg-bp1dmlohjjz4kqaun****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"Name\\": \\"ep01\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\",\\n \\"EndpointSubAddressType\\": \\"primary\\",\\n \\"EndpointZoneId\\": \\"cn-hangzhou-g\\",\\n \\"State\\": \\"active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListBasicEndpointsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <Endpoints>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <Name>ep01</Name>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n <EndpointSubAddressType>primary</EndpointSubAddressType>\\n <EndpointZoneId>cn-hangzhou-g</EndpointZoneId>\\n <State>active</State>\\n </Endpoints>\\n</ListBasicEndpointsResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例的终端节点列表', + ], + 'DeleteBasicEndpoint' => [ + 'summary' => '调用DeleteBasicEndpoint接口删除基础型全球加速实例的终端节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点组Id', + 'description' => '待删除的基础型全球加速实例终端节点所属的终端节点组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '待删除的基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'title' => '终端节点组Id', + 'description' => '基础型全球加速实例终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Exist.EndpointGroup', + 'errorMessage' => 'The endpoint group already exists.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicEndpointResponse>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</DeleteBasicEndpointResponse>","errorExample":""}]', + 'title' => '删除基础型全球加速实例的终端节点', + 'description' => '- **DeleteBasicEndpoint**接口属于异步接口，即系统会先返回一个请求ID，但终端节点未删除完成，系统后台的删除任务仍在进行。您可以调用[ListBasicEndpoints](~~466831~~)查询终端节点的状态：'."\n" + .' - 当终端节点状态为**deleting**时，表示终端节点正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当查询不到该终端节点时，表示终端节点已删除完成。'."\n" + .'- **DeleteBasicEndpoint**接口不支持在同一个基础型全球加速实例内并发删除终端节点。', + ], + 'CreateBasicAccelerateIpEndpointRelations' => [ + 'summary' => '调用CreateBasicAccelerateIpEndpointRelations接口为基础型全球加速实例批量创建加速IP与终端节点的绑定关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速区实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'AccelerateIpEndpointRelations', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '绑定关系列表', + 'description' => '基础型全球加速实例的加速IP和终端节点绑定关系列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定关系列表。', + 'type' => 'object', + 'properties' => [ + 'AccelerateIpId' => [ + 'title' => '加速IpId', + 'description' => '基础型全球加速实例的加速IP实例ID。'."\n" + ."\n" + .'您可以调用[ListBasicAccelerateIps](~~2253393~~)查询加速IP实例ID。'."\n" + ."\n" + .'最多可以输入20个加速IP实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gaip-bp1****', + ], + 'EndpointId' => [ + 'title' => '终端接地点Id', + 'description' => '基础型全球加速实例的终端节点ID。'."\n" + ."\n" + .'您可以调用[ListBasicEndpoints](~~2253406~~)查询终端节点ID。'."\n" + ."\n" + .'最多可以输入20个终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例ID', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicAccelerateIpEndpointRelationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n</CreateBasicAccelerateIpEndpointRelationsResponse>","errorExample":""}]', + 'title' => '为基础型全球加速实例批量创建加速IP与终端节点的绑定关系', + 'description' => '- **CreateBasicAccelerateIpEndpointRelations**接口属于异步接口，即系统会先返回一个请求ID，但批量创建加速IP与终端节点的绑定关系的任务未完成，系统后台的批量创建任务仍在进行。您可以通过调用[GetBasicAccelerateIp](~~466794~~)或[ListBasicEndpoints](~~466831~~)分别查询加速IP和终端节点的状态，来确认加速IP与终端节点的绑定关系是否创建成功： '."\n" + .' - 当存在加速IP与终端节点状态为**binding**时，表示加速IP与终端节点的绑定关系正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当所有加速IP与终端节点状态都为**bound**时，且通过[ListBasicAccelerateIpEndpointRelations](~~466803~~)查询加速IP和终端节点绑定状态为**active**时，表示批量创建加速IP与终端节点绑定关系的任务已完成。'."\n" + .'- **CreateBasicAccelerateIpEndpointRelations**接口不支持在同一个基础型全球加速实例内并发批量创建加速IP与终端节点的绑定关系。', + ], + 'CreateBasicAccelerateIpEndpointRelation' => [ + 'summary' => '调用CreateBasicAccelerateIpEndpointRelation接口为基础型全球加速实例创建加速IP与终端节点的绑定关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速区实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。'."\n" + ."\n" + .'您可以调用[ListBasicEndpoints](~~2253406~~)查询终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。'."\n" + ."\n" + .'您可以调用[ListBasicAccelerateIps](~~2253393~~)查询加速IP实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gaip-bp1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例ID', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'EndpointId' => [ + 'title' => '订单Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'AccelerateIpId' => [ + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'State' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定状态。'."\n" + ."\n" + .'> 该参数当前无实际意义。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EcsCannotBind.BasicEndpoint', + 'errorMessage' => 'The ECS instance has already been associated with another EIP.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"State\\": \\"null\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBasicAccelerateIpEndpointRelationResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <State>null</State>\\n</CreateBasicAccelerateIpEndpointRelationResponse>","errorExample":""}]', + 'title' => '为基础型全球加速实例创建加速IP与终端节点的绑定关系', + 'description' => '- **CreateBasicAccelerateIpEndpointRelation**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例加速IP与终端节点的绑定关系未创建完成，系统后台的创建任务仍在进行。您可以通过调用[GetBasicAccelerateIp](~~466794~~)或[ListBasicEndpoints](~~466831~~)分别查询加速IP和终端节点的状态，来确认加速IP与终端节点的绑定关系是否创建成功： '."\n" + .' - 当加速IP与终端节点状态为**binding**时，表示加速IP与终端节点的绑定关系正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 当加速IP与终端节点状态为**bound**时，且通过[ListBasicAccelerateIpEndpointRelations](~~466803~~)查询加速IP和终端节点绑定状态为**active**时，表示加速IP与终端节点绑定成功。'."\n" + ."\n" + .'- **CreateBasicAccelerateIpEndpointRelation**接口不支持在同一个基础型全球加速实例内并发创建加速IP与终端节点的绑定关系。', + ], + 'GetBasicAccelerateIpEndpointRelation' => [ + 'summary' => '调用GetBasicAccelerateIpEndpointRelation接口查询基础型全球加速实例的加速IP或终端节点的绑定信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Regionid', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '基础版加速实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。'."\n" + ."\n" + .'> **EndpointId**与**AccelerateIpId**不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。'."\n" + .'> **EndpointId**与**AccelerateIpId**不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'gaip-bp1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'EndpointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'EndpointName' => [ + 'title' => '终端节点名称', + 'description' => '基础型全球加速实例终端节点的名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ep01', + ], + 'EndpointType' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'title' => '终端节点子地址', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当加速IP所绑定终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'EndpointSubAddressType' => [ + 'title' => '终端节点子地址类型', + 'description' => '终端节点辅助地址的类型。'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当加速IP所绑定终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。其中，终端节点类型为**NLB**时，仅返回**primary**类型。', + 'type' => 'string', + 'example' => 'primary', + ], + 'EndpointZoneId' => [ + 'title' => '终端节点可用区', + 'description' => '终端节点所在可用区ID。'."\n" + ."\n" + .'目前，仅当加速IP所绑定终端节点类型为**NLB**时，返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'AccelerateIpId' => [ + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'IpAddress' => [ + 'description' => '基础型全球加速实例的加速IP。', + 'type' => 'string', + 'example' => '116.132.XX.XX', + ], + 'State' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定状态。'."\n" + ."\n" + .'返回**active**，表示已绑定。', + 'type' => 'string', + 'example' => 'active', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => ' ga-bp11v53zfftax68b0daws', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointName\\": \\"ep01\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\",\\n \\"EndpointSubAddressType\\": \\"primary\\",\\n \\"EndpointZoneId\\": \\"cn-hangzhou-g\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"IpAddress\\": \\"116.132.XX.XX\\",\\n \\"State\\": \\"active\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\" ga-bp11v53zfftax68b0daws\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBasicAccelerateIpEndpointRelationResponse>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <EndpointName>ep01</EndpointName>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n <EndpointSubAddressType>primary</EndpointSubAddressType>\\n <EndpointZoneId>cn-hangzhou-g</EndpointZoneId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <IpAddress>116.132.XX.XX</IpAddress>\\n <State>active</State>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</GetBasicAccelerateIpEndpointRelationResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例的加速IP或终端节点的绑定信息', + ], + 'ListBasicAccelerateIpEndpointRelations' => [ + 'summary' => '调用ListBasicAccelerateIpEndpointRelations接口查询基础型全球加速实例的加速IP和终端节点的绑定关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速区实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gaip-bp1****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时每次显示的条目数。取值范围：**1**~**50**。默认值：**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'string', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'MaxResults' => [ + 'description' => '分批次查询时每次显示的条目数。', + 'type' => 'string', + 'example' => '10', + ], + 'AccelerateIpEndpointRelations' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定关系列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定关系列表。', + 'type' => 'object', + 'properties' => [ + 'AccelerateIpId' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'IpAddress' => [ + 'title' => '加速Ip', + 'description' => '基础型全球加速实例的加速IP。', + 'type' => 'string', + 'example' => '116.132.XX.XX', + ], + 'EndpointId' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'EndpointName' => [ + 'description' => '基础型全球加速实例终端节点的名称。', + 'type' => 'string', + 'example' => 'ep01', + ], + 'EndpointType' => [ + 'title' => '终端节点类型', + 'description' => '终端节点类型。'."\n" + .'- **ENI**：阿里云弹性网卡。'."\n" + .'- **SLB**：阿里云CLB实例。'."\n" + .'- **ECS**：阿里云ECS实例。'."\n" + .'- **NLB**：阿里云NLB实例。', + 'type' => 'string', + 'example' => 'ENI', + ], + 'EndpointAddress' => [ + 'title' => '终端节点地址', + 'description' => '终端节点的地址。', + 'type' => 'string', + 'example' => 'eni-bp1a05txelswuj8g****', + ], + 'EndpointSubAddress' => [ + 'title' => '终端节点子地址', + 'description' => '终端节点辅助地址。'."\n" + ."\n" + .'当加速IP所绑定终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。'."\n" + .'- 当终端节点类型为**ECS**时，**EndpointSubAddress**为主网卡的辅助私网IP或主网卡的主私网IP。'."\n" + .'- 当终端节点类型为**ENI**时，**EndpointSubAddress**为辅助网卡的辅助私网IP或辅助网卡的主私网IP。'."\n" + .'- 当终端节点类型为**NLB**时，**EndpointSubAddress**为NLB后端服务器的主私网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'EndpointSubAddressType' => [ + 'description' => '终端节点辅助地址的类型。'."\n" + .'- **primary**：终端节点辅助地址的类型为主私网IP。'."\n" + .'- **secondary**：终端节点辅助地址的类型为辅助私网IP。'."\n" + ."\n" + .'当加速IP所绑定终端节点类型为**ECS**、**ENI**或**NLB**时，返回该参数。其中，终端节点类型为**NLB**时，仅返回**primary**类型。', + 'type' => 'string', + 'example' => 'primary', + ], + 'EndpointZoneId' => [ + 'description' => '终端节点所在可用区ID。'."\n" + ."\n" + .'目前，仅当加速IP所绑定终端节点类型为**NLB**时，返回该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'State' => [ + 'title' => '状态', + 'description' => '基础型全球加速实例的加速IP和终端节点绑定状态。'."\n" + ."\n" + .'返回**active**，表示已绑定。', + 'type' => 'string', + 'example' => 'active', + ], + 'AcceleratorId' => [ + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1miyl2kn2racucvegr5', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"AccelerateIpEndpointRelations\\": [\\n {\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"IpAddress\\": \\"116.132.XX.XX\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"EndpointName\\": \\"ep01\\",\\n \\"EndpointType\\": \\"ENI\\",\\n \\"EndpointAddress\\": \\"eni-bp1a05txelswuj8g****\\",\\n \\"EndpointSubAddress\\": \\"172.16.XX.XX\\",\\n \\"EndpointSubAddressType\\": \\"primary\\",\\n \\"EndpointZoneId\\": \\"cn-hangzhou-g\\",\\n \\"State\\": \\"active\\",\\n \\"AcceleratorId\\": \\"ga-bp1miyl2kn2racucvegr5\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListBasicAccelerateIpEndpointRelationsResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <TotalCount>1</TotalCount>\\n <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>\\n <MaxResults>10</MaxResults>\\n <AccelerateIpEndpointRelations>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <IpAddress>116.132.XX.XX</IpAddress>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <EndpointName>ep01</EndpointName>\\n <EndpointType>ENI</EndpointType>\\n <EndpointAddress>eni-bp1a05txelswuj8g****</EndpointAddress>\\n <EndpointSubAddress>172.16.XX.XX</EndpointSubAddress>\\n <EndpointSubAddressType>primary</EndpointSubAddressType>\\n <EndpointZoneId>cn-hangzhou-g</EndpointZoneId>\\n <State>active</State>\\n </AccelerateIpEndpointRelations>\\n</ListBasicAccelerateIpEndpointRelationsResponse>","errorExample":""}]', + 'title' => '查询基础型全球加速实例的加速IP和终端节点的绑定关系', + ], + 'DeleteBasicAccelerateIpEndpointRelation' => [ + 'summary' => '调用DeleteBasicAccelerateIpEndpointRelation接口删除基础型全球加速实例的加速IP和终端节点的绑定关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => '全球加速所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端Token', + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'title' => '全球加速区实例Id', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + ], + [ + 'name' => 'EndpointId', + 'in' => 'query', + 'schema' => [ + 'title' => '终端节点Id', + 'description' => '基础型全球加速实例的终端节点ID。'."\n" + ."\n" + .'您可以调用[ListBasicEndpoints](~~2253406~~)查询终端节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + ], + [ + 'name' => 'AccelerateIpId', + 'in' => 'query', + 'schema' => [ + 'title' => '加速Ip Id', + 'description' => '基础型全球加速实例的加速IP实例ID。'."\n" + ."\n" + .'您可以调用[ListBasicAccelerateIps](~~2253393~~)查询加速IP实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'gaip-bp1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'AcceleratorId' => [ + 'title' => '全球加速实例ID', + 'description' => '基础型全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp17frjjh0udz4qz****', + ], + 'EndpointId' => [ + 'title' => '订单Id', + 'description' => '基础型全球加速实例的终端节点ID。', + 'type' => 'string', + 'example' => 'ep-bp14sz7ftcwwjgrdm****', + ], + 'AccelerateIpId' => [ + 'description' => '基础型全球加速实例的加速IP实例ID。', + 'type' => 'string', + 'example' => 'gaip-bp1****', + ], + 'State' => [ + 'description' => '基础型全球加速实例的加速IP和终端节点绑定状态。'."\n" + ."\n" + .'> 该参数当前无实际意义。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AcceleratorId\\": \\"ga-bp17frjjh0udz4qz****\\",\\n \\"EndpointId\\": \\"ep-bp14sz7ftcwwjgrdm****\\",\\n \\"AccelerateIpId\\": \\"gaip-bp1****\\",\\n \\"State\\": \\"null\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBasicAccelerateIpEndpointRelationResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>\\n <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>\\n <AccelerateIpId>gaip-bp1****</AccelerateIpId>\\n <State>null</State>\\n</DeleteBasicAccelerateIpEndpointRelationResponse>","errorExample":""}]', + 'title' => '删除基础型全球加速实例的加速IP和终端节点的绑定关系', + 'description' => '- **DeleteBasicAccelerateIpEndpointRelation**接口属于异步接口，即系统会先返回一个请求ID，但基础型全球加速实例加速IP与终端节点的绑定关系未删除完成，系统后台的删除任务仍在进行。您可以通过调用以下接口，来确认加速IP与终端节点的绑定关系是否删除成功： '."\n" + .' - 调用[GetBasicAccelerateIp](~~466794~~)或[ListBasicEndpoints](~~466831~~)接口分别查询加速IP和终端节点的状态，当加速IP与终端节点的状态为**unbinding**时，表示加速IP与终端节点的绑定关系正在删除中，在该状态下，您只能执行查询操作，不能执行其他操作。'."\n" + .' - 调用[ListBasicAccelerateIpEndpointRelations](~~466803~~)接口查询不到加速IP和终端节点绑定状态时，表示加速IP与终端节点绑定关系删除成功。'."\n" + .'- **DeleteBasicAccelerateIpEndpointRelation**接口不支持在同一个基础型全球加速实例内并发删除加速IP与终端节点的绑定关系。', + ], + 'UpdateServiceManagedControl' => [ + 'summary' => '通过调用UpdateServiceManagedControl接口对托管状态的资源进行解托管。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作的资源类型。取值：'."\n" + ."\n" + .' **Accelerator**：标准型全球加速实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'Accelerator', + 'enum' => [ + 'Accelerator', + ], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '待操作的资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp149u6o36qt1as9b****', + ], + ], + [ + 'name' => 'ServiceManaged', + 'in' => 'query', + 'schema' => [ + 'description' => '设置资源托管模式。取值： '."\n" + ."\n" + .'**false**：解除当前资源的托管状态。'."\n" + ."\n" + .'> 当前仅支持解除托管。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B7770CB9-9745-4FE5-9EDA-D14B01A12A50', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotSupportResourceType.ServiceManaged', + 'errorMessage' => 'Only accelerator resource type is supported.', + ], + [ + 'errorCode' => 'NotSupportServiceManagedMode.ServiceManaged', + 'errorMessage' => 'Only unmanaged mode is supported.', + ], + [ + 'errorCode' => 'ResourceNotManaged.ServiceManaged', + 'errorMessage' => 'The instance %s is not yet managed.', + ], + [ + 'errorCode' => 'NoPermissionResourceUnmanaged.ServiceManaged', + 'errorMessage' => 'You do not have permission to cancel service managed mode for %s.', + ], + [ + 'errorCode' => 'NoPermission.ServiceManaged', + 'errorMessage' => 'You do not have permission to %s %s in the service managed instance.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7770CB9-9745-4FE5-9EDA-D14B01A12A50\\"\\n}","type":"json"}]', + 'title' => '解除实例的托管状态', + 'description' => '- 此功能只对处于**托管状态**的实例有效。'."\n" + ."\n" + .'- 用户对托管实例解除了托管状态后，不支持重新托管该实例。'."\n" + ."\n" + .'- 用户对托管实例解除了托管状态后，可获取该实例的全部操作权限。'."\n" + .'><warning>用户对解托管的实例进行某些变更操作后（比如删除配置），可能会导致依赖此实例的云服务功能异常，请在操作前确认相应的风险。></warning>', + ], + 'QueryCrossBorderApprovalStatus' => [ + 'summary' => '调用QueryCrossBorderApprovalStatus接口查询阿里云账号（主账号）的跨境权限审批状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F96E634B-A523-587F-9A09-AE8B2FD04B9C', + ], + 'ApprovalStatus' => [ + 'description' => '阿里云账号（主账号）是否拥有跨境权限。'."\n" + .'- UNAPPLIED：用户未提交跨境权限申请或无法查到相应的纪录。'."\n" + .'- APPLIED：用户已经提交跨境权限申请，当前在审核中。'."\n" + .'- REJECTED：用户提交的跨境权限审核失败。'."\n" + .'- PASSED：用户提交的跨境权限审核通过。', + 'type' => 'string', + 'example' => 'UNAPPLIED', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F96E634B-A523-587F-9A09-AE8B2FD04B9C\\",\\n \\"ApprovalStatus\\": \\"UNAPPLIED\\"\\n}","type":"json"}]', + 'title' => '查询阿里云账号的跨境权限审批状态', + ], + 'DescribeAcceleratorServiceStatus' => [ + 'summary' => '查询全球加速后付费服务开通状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6FEA0CF3-D3B9-43E5-A304-D217037876A8', + ], + 'Status' => [ + 'title' => '服务开通状态', + 'description' => '服务开通状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Released' => '欠费释放', + 'Expired' => '欠费过期', + 'NotOpened' => '未开通', + 'Normal' => '已开通', + ], + 'example' => 'Normal', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否调用成功。true：调用成功。false：调用失败。', + 'type' => 'string', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6FEA0CF3-D3B9-43E5-A304-D217037876A8\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '查询全球加速后付费服务开通状态', + ], + 'OpenAcceleratorService' => [ + 'summary' => '您如果使用全球加速后付费实例，必须开通全球加速后付费服务，该接口可用于开通全球加速后付费服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174750', + 'abilityTreeNodes' => [ + 'FEATUREgaLOR9WO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。 '."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '当次请求的Request ID。', + 'type' => 'string', + 'example' => 'B49B60F6-F6C8-49E5-B06B-E33E3A469A92', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '208257****', + ], + 'Code' => [ + 'description' => '返回状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：表示调用成功。 '."\n" + .'- **false**：表示调用失败。', + 'type' => 'string', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '返回响应描述。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B49B60F6-F6C8-49E5-B06B-E33E3A469A92\\",\\n \\"OrderId\\": 0,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '开通全球加速后付费服务', + ], + 'ListEndpointGroupIpAddressCidrBlocks' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '179651', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EndpointGroupRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ga-bp17frjjh0udz4q****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndpointGroupRegion' => [ + 'description' => '终端节点组所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IpAddressCidrBlocks' => [ + 'description' => 'Ip地址段列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Ip地址段', + 'type' => 'string', + 'example' => '10.x.x.x/24', + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aekztkx4zwc****', + ], + 'State' => [ + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'active', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B6DBBB0-2D01-4C6A-A384-4129266E6B78', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndpointGroupRegion\\": \\"cn-hangzhou\\",\\n \\"IpAddressCidrBlocks\\": [\\n \\"10.x.x.x/24\\"\\n ],\\n \\"ResourceGroupId\\": \\"rg-aekztkx4zwc****\\",\\n \\"State\\": \\"active\\",\\n \\"RequestId\\": \\"4B6DBBB0-2D01-4C6A-A384-4129266E6B78\\"\\n}","type":"json"}]', + 'title' => '查询终端节点公网IP地址段', + 'summary' => '通过该接口可以获取到Ga实例下终端节点组出公网IP所属的公网IP地址段列表，可用于用户终端ACL配置。', + ], + 'UpdateLogStoreConfig' => [ + 'summary' => '修改SLS日志配置', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '280607', + 'abilityTreeNodes' => [ + 'FEATUREgaMGA0JD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SlsProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务项目（Project）名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-access-log', + ], + ], + [ + 'name' => 'SlsLogStoreName', + 'in' => 'query', + 'schema' => [ + 'description' => '日志库（Logstore）名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-access-log-epg-01', + ], + ], + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'ListenerId', + 'in' => 'query', + 'schema' => [ + 'description' => '监听ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'lsr-xxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'EndpointGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端节点组的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'epg-bp1dmlohjjz4kqaun****', + ], + ], + [ + 'name' => 'AccessLogRecordCustomizedHeadersEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '访问日志是否开启携带自定义头字段。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**（默认值）：否。'."\n" + ."\n" + .'> 只有实例访问日志开关**AccessLogEnabled**打开时，才能设置此参数为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + [ + 'name' => 'AccessLogRecordCustomizedHeaderList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '访问日志携带自定义头字段名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '访问日志携带自定义头字段名称', + 'type' => 'string', + 'required' => false, + 'example' => '[\'Content-Type\', \'User-Agent\']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\"\\n}","type":"json"}]', + 'title' => '修改访问日志配置', + ], + 'GetGlobalAcceleratorResources' => [ + 'summary' => '获取GA实例关联的云产品', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '285204', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所在的地域ID，仅取值cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AssociatedResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的周边资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'WAF', + ], + ], + [ + 'name' => 'AssociatedResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AssociatedResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的周边资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'waf_v2_public_cn-x0r****gr1i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'AssociatedResources' => [ + 'description' => '关联资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联资源详情。', + 'type' => 'object', + 'properties' => [ + 'AssociatedResourceType' => [ + 'description' => '关联资源的资源类型。', + 'type' => 'string', + 'example' => 'WAF', + ], + 'AssociatedResourceId' => [ + 'description' => '关联资源ID。', + 'type' => 'string', + 'example' => 'waf_v2_public_cn-x0r****gr1i', + ], + 'AssociatedResourceRegionId' => [ + 'description' => '关联资源所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AssociatedMode' => [ + 'description' => '关联模式：'."\n" + .'- **Managed**：托管，GA侧根据托管策略限制用户操作。'."\n" + .'- **Associated**（默认）：松耦合关联，GA侧不会限制用户操作，WAF属于松耦合。', + 'type' => 'string', + 'example' => 'Associated', + ], + 'State' => [ + 'description' => '全球加速实例与其他云产品资源关联的状态。'."\n" + ."\n" + .'- **active**：可用。'."\n" + ."\n" + .'- **binding**：绑定中。'."\n" + ."\n" + .'- **unBinding**：解绑中。'."\n" + ."\n" + .'- **wafRelease**：WAF实例已释放。', + 'type' => 'string', + 'example' => 'active', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"AssociatedResources\\": [\\n {\\n \\"AssociatedResourceType\\": \\"WAF\\",\\n \\"AssociatedResourceId\\": \\"waf_v2_public_cn-x0r****gr1i\\",\\n \\"AssociatedResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"AssociatedMode\\": \\"Associated\\",\\n \\"State\\": \\"active\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询GA实例关联的周边资源', + ], + 'DisassociateResources' => [ + 'summary' => '解绑GA集成云产品', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '285203', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'AssociatedResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的周边资源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'WAF', + 'enum' => [ + 'WAF', + ], + ], + ], + [ + 'name' => 'AssociatedResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cd498437eb9a346c38be8482689800e91', + ], + ], + [ + 'name' => 'AssociatedResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例所属的地域ID，仅取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会解绑资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + 'AssociatedResourceId' => [ + 'description' => '关联资源ID。', + 'type' => 'string', + 'example' => 'c66d65f411b9143bab253bfef61c03c48', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'The accelerated instance does not exist.', + ], + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'Ga::2019-11-20::DescribeAccelerator', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 30, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\",\\n \\"AssociatedResourceId\\": \\"c66d65f411b9143bab253bfef61c03c48\\"\\n}","type":"json"}]', + 'title' => '将周边资源与全球加速实例解绑', + ], + 'AssociateResources' => [ + 'summary' => 'GA集成云产品', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '285202', + 'abilityTreeNodes' => [ + 'FEATUREga231EJR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorId', + 'in' => 'query', + 'schema' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + [ + 'name' => 'AssociatedResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源的资源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'WAF', + 'enum' => [ + 'WAF', + ], + ], + ], + [ + 'name' => 'AssociatedResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源的资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'waf_xx', + ], + ], + [ + 'name' => 'AssociatedResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联资源的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AssociatedMode', + 'in' => 'query', + 'schema' => [ + 'description' => '关联模式：'."\n" + .'- **Managed**：托管，GA侧根据托管策略限制用户操作。目前无此类型资源。'."\n" + .'- **Associated**（默认）：松耦合关联，GA侧不会限制用户操作，WAF属于松耦合。', + 'type' => 'string', + 'required' => false, + 'example' => 'Associated', + 'default' => 'Associated', + 'enum' => [ + 'Associated', + 'Managed', + ], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '基础型全球加速实例所在的地域ID，仅取值**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会进行资源关联。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回HTTP 2xx状态码。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建终端节点组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6', + ], + 'AssociatedResourceId' => [ + 'description' => '关联资源ID。', + 'type' => 'string', + 'example' => 'waf_xx', + ], + 'AcceleratorId' => [ + 'description' => '全球加速实例ID。', + 'type' => 'string', + 'example' => 'ga-bp1odcab8tmno0hdq****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StateError.Accelerator', + 'errorMessage' => 'accelerator state %s is illegal', + ], + [ + 'errorCode' => 'NotExist.Accelerator', + 'errorMessage' => 'accelerator %s is not exist', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'Ga::2019-11-20::DescribeAccelerator', + 'callbackInterval' => 10000, + 'maxCallbackTimes' => 30, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6\\",\\n \\"AssociatedResourceId\\": \\"waf_xx\\",\\n \\"AcceleratorId\\": \\"ga-bp1odcab8tmno0hdq****\\"\\n}","type":"json"}]', + 'title' => '将周边资源与全球加速实例绑定', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ga.cn-hangzhou.aliyuncs.com', + ], + ], +]; |