文档

API概览

更新时间:
本产品(全球加速/2019-11-20)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

区域与地域

API标题API概述
ListAccelerateAreas查询可用的加速区域和地域调用ListAccelerateAreas查询可用的加速区域和地域。
ListBusiRegions查询加速业务支持的地域调用ListBusiRegions查询全球加速服务支持的地域。
DescribeRegions查询可用的实例部署的地域调用DescribeRegions查询可用的全球加速实例部署地域。
ListAvailableBusiRegions列出可用的业务区域调用ListAvailableBusiRegions接口查询指定全球加速实例可用的加速地域。
ListCommonAreas查询加速业务支持的地域调用ListCommonAreas接口查询可用的加速区域和地域。

资源组

API标题API概述
ChangeResourceGroup修改全球加速资源所属的资源组调用ChangeResourceGroup接口修改全球加速资源所属的资源组。

标签

API标题API概述
TagResources为全球加速资源添加标签调用TagResources接口为全球加速资源添加标签。
ListTagResources查询全球加速资源已经绑定的标签列表调用ListTagResources接口查询全球加速资源已经绑定的标签列表。
UntagResources为全球加速相关资源删除标签调用UntagResources接口为全球加速相关资源删除标签。

询价

API标题API概述
DescribeCommodity查询全球加速商品信息调用DescribeCommodity接口查询全球加速商品信息。
DescribeCommodityPrice查询全球加速商品的价格信息调用DescribeCommodityPrice接口查询全球加速商品的价格信息。

带宽包

API标题API概述
BandwidthPackageAddAccelerator将带宽包与全球加速实例绑定调用BandwidthPackageAddAccelerator接口将带宽包与全球加速实例绑定。
BandwidthPackageRemoveAccelerator将带宽包与全球加速实例解绑调用BandwidthPackageRemoveAccelerator接口将带宽包与全球加速实例解绑。
DescribeBandwidthPackage查询带宽包调用DescribeBandwidthPackage接口查询带宽包详细信息。
ListBandwidthPackages查询带宽包列表调用ListBandwidthPackages接口查询带宽包列表。
UpdateBandwidthPackage修改带宽包的配置调用UpdateBandwidthPackage接口修改带宽包的配置。
ReplaceBandwidthPackage替换带宽包调用ReplaceBandwidthPackage接口为全球加速实例替换带宽包。
DeleteBandwidthPackage删除指定带宽包调用DeleteBandwidthPackage接口删除指定的带宽包。
CreateBandwidthPackage创建指定带宽包调用CreateBandwidthPackage接口创建指定的带宽包。
ListBandwidthackages获取带宽包列表调用ListBandwidthackages接口获取带宽包列表。
DescribeBandwidthPackageAutoRenewAttribute查询包年包月带宽包自动续费状态调用DescribeBandwidthPackageAutoRenewAttribute接口查询带宽包自动续费状态。
UpdateBandwidthPackagaAutoRenewAttribute修改带宽包的自动续费属性调用UpdateBandwidthPackagaAutoRenewAttribute接口修改带宽包的自动续费属性。

公网线路类型及传输网络质量类型

API标题API概述
ListIspTypes查询加速地域支持的公网线路类型调用ListIspTypes接口查询加速地域支持的公网线路类型。
UpdateAcceleratorCrossBorderMode修改全球加速实例的传输网络质量类型调用UpdateAcceleratorCrossBorderMode接口修改全球加速实例的传输网络质量类型。
UpdateAcceleratorCrossBorderStatus开启全球加速实例的跨境传输服务开启全球加速实例的跨境传输服务。

全球加速实例

API标题API概述
CreateAccelerator创建一个全球加速实例全球加速 GA(Global Accelerator)是一款覆盖全球的网络加速服务,依托阿里云优质BGP带宽和全球传输网络,实现全球网络就近接入,可以减少延迟、抖动、丢包等网络问题对服务质量的影响,为全球用户提供高可用和高性能的网络加速服务,您可以通过调用CreateAccelerator接口创建一个全球加速实例。
DescribeAccelerator查询指定的全球加速实例信息调用DescribeAccelerator接口查询指定的全球加速实例信息。
ListAccelerators查询全球加速实例列表调用ListAccelerators接口查询全球加速实例列表。
UpdateAccelerator修改全球加速实例调用UpdateAccelerator接口修改全球加速实例。
UpdateAcceleratorConfirm确认修改的全球加速实例规格信息调用UpdateAcceleratorConfirm接口确认修改的全球加速实例规格信息。
DeleteAccelerator删除全球加速实例调用DeleteAccelerator接口删除指定的全球加速实例。
AttachDdosToAccelerator将DDoS高防实例与全球加速实例绑定如果您想让全球加速的应用不受大规模DDoS攻击的影响,确保服务的稳定性和可用性,您可以调用AttachDdosToAccelerator接口将DDoS高防实例与全球加速实例绑定。
DetachDdosFromAccelerator将DDoS高防实例与全球加速实例解绑调用DetachDdosFromAccelerator接口将DDoS高防实例与全球加速实例解绑。
CreateSpareIps创建CNAME备用IP调用CreateSpareIps接口创建CNAME备用IP,当加速区域异常时,流量可切换到备用IP。
ListSpareIps查询CNAME备用IP列表信息调用ListSpareIps接口查询CNAME备用IP列表信息。
GetSpareIp查询CNAME备用IP的状态调用GetSpareIp接口查询CNAME备用IP的状态。
DeleteSpareIps删除CNAME备用IP调用DeleteSpareIps接口删除CNAME备用IP。
DescribeAcceleratorAutoRenewAttribute查询全球加速实例的自动续费状态调用DescribeAcceleratorAutoRenewAttribute接口查询全球加速实例的自动续费状态。
UpdateAcceleratorAutoRenewAttribute修改全球加速实例的自动续费属性调用UpdateAcceleratorAutoRenewAttribute接口修改全球加速实例的自动续费属性。

加速区域

API标题API概述
CreateIpSets批量创建加速地域调用CreateIpSets接口批量创建加速地域。
DescribeIpSet查询加速地域调用DescribeIpSet接口查询指定加速地域的信息。
ListIpSets查询加速地域列表调用ListIpSets接口查询指定全球加速实例的加速地域列表。
UpdateIpSet修改加速区域中指定的加速地域调用UpdateIpSet接口修改加速区域中指定的加速地域。
UpdateIpSets修改加速区域中的多个加速地域调用UpdateIpSets接口修改加速区域中的多个加速地域。
DeleteIpSet删除一个加速地域调用DeleteIpSet接口删除一个加速地域。
DeleteIpSets删除多个加速地域调用DeleteIpSets接口删除多个加速地域。
ListAvailableAccelerateAreas列出可用加速区域调用ListAvailableAccelerateAreas接口查询可用的加速地域。
GetIpsetsBandwidthLimit查询加速地域带宽阈值调用GetIpsetsBandwidthLimit接口获取加速区域带宽阈值。

监听

API标题API概述
CreateListener创建监听监听负责检查连接请求,然后根据调度算法定义的转发策略将请求流量分发至终端节点。您可以调用CreateListener接口为全球加速实例创建监听。
DescribeListener查询监听调用DescribeListener接口查询指定监听的配置信息。
ListListeners查询监听列表调用ListListeners接口查询指定全球实例下的监听列表。
UpdateListener修改监听修改全球加速实例下指定监听的配置。
DeleteListener删除监听调用DeleteListener接口删除监听。
GetHealthStatus获取监听下终端节点组和终端节点的健康状态调用GetHealthStatus接口获取指定监听下终端节点组和终端节点的健康状态信息。
AssociateAdditionalCertificatesWithListener为HTTPS监听绑定扩展证书为全球加速HTTPS协议监听绑定多个证书,并结合虚拟终端节点组和转发策略功能,可实现加速访问多个HTTPS域名。您可以调用AssociateAdditionalCertificatesWithListener接口为HTTPS监听绑定扩展证书。
DissociateAdditionalCertificatesFromListener将扩展证书与HTTPS监听解绑将扩展证书与HTTPS监听解绑。
UpdateAdditionalCertificateWithListener为HTTPS监听替换扩展证书为HTTPS监听替换扩展证书。
ListListenerCertificates查询监听绑定的证书列表查询监听绑定的证书列表。
ListSystemSecurityPolicies查询HTTPS监听支持的TLS系统安全策略列表查询HTTPS监听支持的TLS系统安全策略列表。

终端节点组(智能路由类型监听)

API标题API概述
CreateEndpointGroup创建终端节点组调用CreateEndpointGroup接口创建终端节点组。
DescribeEndpointGroup查询指定终端节点组信息调用DescribeEndpointGroup接口查询指定终端节点组信息。
ListEndpointGroups查询终端节点组列表调用ListEndpointGroups接口查询终端节点组列表。
UpdateEndpointGroup修改终端节点组的业务配置调用UpdateEndpointGroup接口修改终端节点组配置信息。
UpdateEndpointGroupAttribute修改终端节点组的名称和描述调用UpdateEndpointGroupAttribute接口修改终端节点组的名称和描述。
DeleteEndpointGroup删除终端节点组调用DeleteEndpointGroup接口删除终端节点组。
DescribeLogStoreOfEndpointGroup查询终端节点组关联的SLS日志库调用DescribeLogStoreOfEndpointGroup接口查询终端节点组关联的SLS日志库信息。
AttachLogStoreToEndpointGroup关联SLS日志库到终端节点组调用AttachLogStoreToEndpointGroup接口关联SLS日志库到终端节点组。
DetachLogStoreFromEndpointGroup解除SLS日志库和终端节点组的关联关系调用DetachLogStoreFromEndpointGroup接口解除SLS日志库和终端节点组的关联关系。
CreateEndpointGroups创建终端节点组列表调用CreateEndpointGroups接口批量创建终端节点组。
UpdateEndpointGroups批量修改某个监听下的终端节点组批量修改某个监听下的终端节点组。
ConfigEndpointProbe配置终端节点时延探测调用ConfigEndpointProbe接口配置终端节点时延探测。
DeleteEndpointGroups删除终端节点组列表调用DeleteEndpointGroups接口批量删除终端节点组。

终端节点组(自定义路由类型监听)

API标题API概述
CreateCustomRoutingEndpointGroups批量创建自定义路由类型监听的终端节点组批量创建自定义路由类型监听的终端节点组。
UpdateCustomRoutingEndpointGroupAttribute修改自定义路由类型监听关联的终端节点组名称和描述信息修改自定义路由类型监听关联的终端节点组名称和描述信息。
DescribeCustomRoutingEndpointGroup查询自定义路由类型监听关联的指定终端节点组配置信息查询自定义路由类型监听关联的指定终端节点组配置信息。
ListCustomRoutingEndpointGroups查询自定义路由类型监听关联的终端节点组调用ListCustomRoutingEndpointGroups接口查询自定义路由类型监听关联的终端节点组。
DeleteCustomRoutingEndpointGroups批量删除自定义路由类型监听关联的终端节点组调用DeleteCustomRoutingEndpointGroups接口批量删除自定义路由类型监听关联的终端节点组。

终端节点组映射信息(自定义路由类型监听)

API标题API概述
CreateCustomRoutingEndpointGroupDestinations创建自定义路由监听所关联终端节点组的映射信息创建自定义路由监听所关联终端节点组的映射信息。
UpdateCustomRoutingEndpointGroupDestinations修改自定义路由类型监听所关联终端节点组的映射信息修改自定义路由类型监听所关联终端节点组的映射信息。
DescribeCustomRoutingEndpointGroupDestinations查询指定的终端节点组映射信息配置查询指定的终端节点组映射信息配置(自定义路由类型监听)。
ListCustomRoutingEndpointGroupDestinations查询终端节点组的映射信息配置列表查询终端节点组的映射信息配置列表(自定义路由类型监听)。
DeleteCustomRoutingEndpointGroupDestinations删除自定义路由类型监听所关联终端节点组的映射信息删除自定义路由类型监听所关联终端节点组的映射信息。

终端节点(自定义路由类型监听)

API标题API概述
CreateCustomRoutingEndpoints创建自定义路由类型监听的终端节点创建自定义路由类型监听的终端节点。
UpdateCustomRoutingEndpoints修改自定义路由类型监听的终端节点修改自定义路由类型监听的终端节点。
DescribeCustomRoutingEndpoint查询自定义终端节点查询终端节点配置。
ListCustomRoutingEndpoints查询自定义终端节点列表查询终端节点配置。
DeleteCustomRoutingEndpoints删除自定义路由类型监听的终端节点删除自定义路由类型监听的终端节点。

终端节点流量通行目标(自定义路由类型监听)

API标题API概述
CreateCustomRoutingEndpointTrafficPolicies创建终端节点流量通行目标调用CreateCustomRoutingEndpointTrafficPolicies接口创建终端节点流量通行目标(自定义路由类型监听)。
UpdateCustomRoutingEndpointTrafficPolicies修改终端节点流量通行目标调用UpdateCustomRoutingEndpointTrafficPolicies接口修改终端节点流量通行目标(自定义路由类型监听)。
DescribeCustomRoutingEndPointTrafficPolicy查询指定终端节点流量通行目标调用DescribeCustomRoutingEndPointTrafficPolicy接口查询指定终端节点流量通行目标。
ListCustomRoutingEndpointTrafficPolicies查询终端节点流量通行目标列表调用ListCustomRoutingEndpointTrafficPolicies接口查询终端节点流量通行目标列表(自定义路由类型监听)。
DeleteCustomRoutingEndpointTrafficPolicies删除终端节点流量通行目标调用DeleteCustomRoutingEndpointTrafficPolicies接口删除终端节点流量通行目标。

端口映射表(自定义路由类型监听)

API标题API概述
ListCustomRoutingPortMappings查询生成的端口映射表查询生成的端口映射表(自定义路由类型监听)。
ListCustomRoutingPortMappingsByDestination查询指定后端实例的端口映射表查询指定后端实例的端口映射表(自定义路由类型监听)。

转发策略

API标题API概述
CreateForwardingRules创建转发规则创建转发策略。
UpdateForwardingRules更新转发规则更新转发策略。
ListForwardingRules获取转发规则列表查看已经创建的转发策略信息。
DeleteForwardingRules删除转发规则删除转发策略。

访问控制

API标题API概述
CreateAcl创建访问控制策略组调用CreateAcl接口创建访问控制策略组。
UpdateAclAttribute修改访问控制策略组属性调用UpdateAclAttribute接口修改访问控制策略组属性。
AddEntriesToAcl在访问控制策略组中添加IP条目为访问控制策略组添加IP条目,并通过设置白名单或黑名单来允许或者限制监听对这些IP条目访问请求的转发,可实现客户端请求的精确控制。您可以通过调用AddEntriesToAcl接口在访问控制策略组中添加IP条目。
RemoveEntriesFromAcl删除访问控制策略组中的IP条目调用RemoveEntriesFromAcl接口删除访问控制策略组中的IP条目。
ListAcls查询ACL列表调用ListAcls接口查询访问控制列表。
GetAcl获取访问控制策略调用GetAcl接口获取访问控制策略。
DeleteAcl删除访问控制调用DeleteAcl接口删除访问控制策略组。
AssociateAclsWithListener关联ACL到监听调用AssociateAclsWithListener接口将访问控制策略组(ACL)关联到监听。
DissociateAclsFromListener将ACL与监听解除关联调用DissociateAclsFromListener接口将访问控制策略组(ACL)与监听解除关联。

源站探测

API标题API概述
CreateApplicationMonitor创建源站探测任务调用CreateApplicationMonitor接口创建源站探测任务。
UpdateApplicationMonitor修改源站探测任务配置调用UpdateApplicationMonitor接口修改源站探测任务配置。
DisableApplicationMonitor关闭源站探测调用DisableApplicationMonitor接口关闭源站探测。
EnableApplicationMonitor开启源站探测调用EnableApplicationMonitor接口开启源站探测。
DeleteApplicationMonitor删除源站探测任务调用DeleteApplicationMonitor接口删除源站探测任务。
ListApplicationMonitor查询源站探测任务列表调用ListApplicationMonitor接口查询源站探测任务列表。
DescribeApplicationMonitor查询源站探测任务详细信息调用DescribeApplicationMonitor接口查询源站探测任务详细信息。
DetectApplicationMonitor开启诊断调用DetectApplicationMonitor为指定源站探测任务开启诊断。
ListApplicationMonitorDetectResult查询源站探测任务的诊断结果调用ListApplicationMonitorDetectResult接口查询源站探测任务的诊断结果。

域名管理

API标题API概述
CreateDomain创建域名创建域名,并关联GaId。
UpdateDomainState修改域名状态更新加速域名的ICP备案状态。
UpdateDomain修改加速域名更新域名名称。
ListDomains查询域名与状态查询加速域名。
GetInvalidDomainCount获取无效域名总数获取违规域名个数。
DeleteDomainAcceleratorRelation删除加速域名的配置删除domain-accelerator关系。

基础型全球加速实例

API标题API概述
CreateBasicAccelerator创建基础型全球加速实例基础型全球加速实例依托阿里云优质的全球互联网带宽与高品质传输网络,为用户提供点到点的加速体验。基础型全球加速实例主要用于三层(IP协议)网络加速。您可以通过调用CreateBasicAccelerator接口创建一个基础型全球加速实例。
UpdateBasicAccelerator修改基础型全球加速实例调用UpdateBasicAccelerator接口修改基础型全球加速实例的名称与描述信息。
GetBasicAccelerator查询基础型全球加速实例的信息调用GetBasicAccelerator接口查询指定的基础型全球加速实例的信息。
ListBasicAccelerators查询基础型全球加速实例列表调用ListBasicAccelerators接口查询基础型全球加速实例列表。
DeleteBasicAccelerator删除基础型全球加速实例调用DeleteBasicAccelerator接口删除指定的基础型全球加速实例。

加速地域(基础型全球加速实例)

API标题API概述
CreateBasicIpSet创建基础型全球加速实例的加速地域调用CreateBasicIpSet接口创建基础型全球加速实例的加速地域。
UpdateBasicIpSet修改基础型全球加速实例的加速地域带宽调用UpdateBasicIpSet接口修改基础型全球加速实例的接入地域带宽。
GetBasicIpSet查询指定基础型全球加速实例的加速地域信息调用GetBasicIpSet接口查询指定基础型全球加速实例的加速地域信息。
DeleteBasicIpSet删除基础性全球加速实例的加速地域调用DeleteBasicIpSet接口删除基础型全球加速实例的加速地域。

加速IP(基础型全球加速实例)

API标题API概述
CreateBasicAccelerateIp为基础型全球加速实例创建加速IP调用CreateBasicAccelerateIp接口为基础型全球加速实例创建加速IP。
GetBasicAccelerateIp查询基础型全球加速实例下指定加速IP的信息调用GetBasicAccelerateIp接口查询基础型全球加速实例下指定加速IP的信息。
GetBasicAccelerateIpIdleCount查询基础型全球加速实例的闲置加速IP数量调用GetBasicAccelerateIpIdleCount接口查询基础型全球加速实例的闲置加速IP数量。
ListBasicAccelerateIps查询基础型全球加速实例加速地域下的加速IP信息调用ListBasicAccelerateIps接口查询基础型全球加速实例加速地域下的加速IP信息。
DeleteBasicAccelerateIp删除基础型全球加速实例的加速IP调用DeleteBasicAccelerateIp接口删除基础型全球加速实例的加速IP。

终端节点组(基础型全球加速实例)

API标题API概述
CreateBasicEndpointGroup创建基础型全球加速实例的终端节点组调用CreateBasicEndpointGroup接口创建基础型全球加速实例的终端节点组。
UpdateBasicEndpointGroup修改基础型终端节点组配置信息调用UpdateBasicEndpointGroup接口修改基础型终端节点组配置信息。
GetBasicEndpointGroup查询指定基础型全球加速实例的终端节点组信息调用GetBasicEndpointGroup接口查询指定基础型全球加速实例的终端节点组信息。
DeleteBasicEndpointGroup删除基础型全球加速实例的终端节点组调用DeleteBasicEndpointGroup接口删除基础型全球加速实例的终端节点组。

终端节点(基础型全球加速实例)

API标题API概述
CreateBasicEndpoint为基础型全球加速实例创建终端节点调用CreateBasicEndpoint接口为基础型全球加速实例创建终端节点。
CreateBasicEndpoints为基础型全球加速实例批量创建终端节点调用CreateBasicEndpoints接口为基础型全球加速实例批量创建终端节点。
UpdateBasicEndpoint修改基础型全球加速实例的终端节点名称调用UpdateBasicEndpoint接口修改基础型全球加速实例的终端节点名称。
GetBasicEndpoint查询基础型全球加速实例下指定终端节点的信息调用GetBasicEndpoint接口查询基础型全球加速实例下指定终端节点的信息。
ListBasicEndpoints查询基础型全球加速实例的终端节点列表调用ListBasicEndpoints接口查询基础型全球加速实例的终端节点列表。
DeleteBasicEndpoint删除基础型全球加速实例的终端节点调用DeleteBasicEndpoint接口删除基础型全球加速实例的终端节点。

加速IP与终端节点的绑定关系(基础型全球加速实例)

API标题API概述
CreateBasicAccelerateIpEndpointRelations为基础型全球加速实例批量创建加速IP与终端节点的绑定关系调用CreateBasicAccelerateIpEndpointRelations接口为基础型全球加速实例批量创建加速IP与终端节点的绑定关系。
CreateBasicAccelerateIpEndpointRelation为基础型全球加速实例创建加速IP与终端节点的绑定关系调用CreateBasicAccelerateIpEndpointRelation接口为基础型全球加速实例创建加速IP与终端节点的绑定关系。
GetBasicAccelerateIpEndpointRelation查询基础型全球加速实例的加速IP或终端节点的绑定信息调用GetBasicAccelerateIpEndpointRelation接口查询基础型全球加速实例的加速IP或终端节点的绑定信息。
ListBasicAccelerateIpEndpointRelations查询基础型全球加速实例的加速IP和终端节点的绑定关系调用ListBasicAccelerateIpEndpointRelations接口查询基础型全球加速实例的加速IP和终端节点的绑定关系。
DeleteBasicAccelerateIpEndpointRelation删除基础型全球加速实例的加速IP和终端节点的绑定关系调用DeleteBasicAccelerateIpEndpointRelation接口删除基础型全球加速实例的加速IP和终端节点的绑定关系。

其他

API标题API概述
UpdateServiceManagedControl解除实例的托管状态通过调用UpdateServiceManagedControl接口对托管状态的资源进行解托管。
QueryCrossBorderApprovalStatus查询阿里云账号的跨境权限审批状态查询阿里云账号(主账号)的跨境权限审批状态。
DescribeAcceleratorServiceStatus查询全球加速后付费服务开通状态查询全球加速后付费服务开通状态。
OpenAcceleratorService开通全球加速后付费服务您如果使用全球加速后付费实例,必须开通全球加速后付费服务,该接口可用于开通全球加速后付费服务。
ListEndpointGroupIpAddressCidrBlocks查询终端节点公网IP地址段通过该接口可以获取到终端节点组出公网IP所属的公网IP地址段列表,可用于用户终端ACL配置。
  • 本页导读 (1)
文档反馈