/** * DescribeTaskResult返回参数结构体 */ export interface DescribeTaskResultResponse { /** * 任务状态。 */ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlobalAcceleratorAccessLog请求参数结构体 */ export interface DeleteGlobalAcceleratorAccessLogRequest { /** *
日志唯一Id
*/ LogPushTaskId: string; /** *GA实例唯一Id
*/ GlobalAcceleratorId: string; } /** * DescribeEndpointGroups返回参数结构体 */ export interface DescribeEndpointGroupsResponse { /** *符合条件的终端节点组。
*/ EndpointGroupConfigurationSet?: Array符合条件的实例个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReplaceListenerAdditionalCert返回参数结构体 */ export interface ReplaceListenerAdditionalCertResponse { /** * 任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateForwardingRule请求参数结构体 */ export interface CreateForwardingRuleRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *策略ID。
*/ ForwardingPolicyId: string; /** *七层转发规则条件信息。
数组长度最大不能超过1。
*/ RuleConditions: Array七层转发规则行为信息。
数组长度最大不能超过1。
*/ RuleActions: Array回源Header信息。
数组长度最大不能超过5。当RuleActions.RuleActionType是ForwardGroup时,此字段必传。
*/ OriginHeaders?: Array是否开启回源sni。
默认值:False
当RuleActions.RuleActionType是ForwardGroup时,此字段必传。
*/ EnableOriginSni?: boolean; /** *回源sni。
入参限制:长度不能超过80。
当EnableOriginSni为True时,此字段必传。当RuleActions.RuleActionType是ForwardGroup时,此字段必传。
*/ OriginSni?: string; /** *回源host。
入参限制:长度不超过80。
当RuleActions.RuleActionType是ForwardGroup时,此字段必传。
*/ OriginHost?: string; /** *源站响应头
数组长度不超过5。可以传空数组,代表清空配置。
*/ ResponseHeaders?: Array删除源站响应头
数组长度不超过5。可以传空数组,代表清空配置。
*/ HideResponseHeaders?: Array返回日志任务详情
*/ GlobalAcceleratorAccessLog?: Array日志任务条数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeForwardingPolicy返回参数结构体 */ export interface DescribeForwardingPolicyResponse { /** * 符合条件的策略信息。 */ ForwardingPolicySet?: Array名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name: string; /** *计费模式,PREPAID:表示预付费,即包年包月,POSTPAID:表示后付费,即按量计费。默认:POSTPAID。当前仅支持后付费。
*/ InstanceChargeType?: string; /** *描述信息。
参数格式:最大长度不超过100 个字符。
*/ Description?: string; /** *跨境类型;HighQuality:精品BGP-IP跨境;Unicom:联通专线跨境。
*/ CrossBorderType?: string; /** *此Flag代表签署跨境服务承诺书。当使用跨境服务时候,此字段必传。True:代表签署。
*/ CrossBorderPromiseFlag?: boolean; /** *标签信息
*/ Tags?: Array任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlobalAcceleratorAclPolicy返回参数结构体 */ export interface DeleteGlobalAcceleratorAclPolicyResponse { /** * 异步任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAccelerateAreas返回参数结构体 */ export interface CreateAccelerateAreasResponse { /** *异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEndpointGroups请求参数结构体 */ export interface DescribeEndpointGroupsRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *偏移量,默认为0。
*/ Offset?: number; /** *返回数量,默认为10,最大值为10。
*/ Limit?: number; /** *过滤条件。 endpoint-group-id- String -(过滤条件)终端节点组实例ID。endpoint-group-type- String -(过滤条件)终端节点组实例类型。
*/ Filters?: Arraykey
参数格式:1、字符串只包含可打印的ASCII字符 2、不能包含这些字符()<>@,;:\"/[ ]?={ }
入参限制:长度在1-40。
*/ Key: string; /** *value
入参限制:长度不能超过128
如果字符串包含$,那仅能配置'$remote_addr', '$remote_port',否则不支持。
*/ Value: string; } /** * DescribeGlobalAcceleratorAclRules请求参数结构体 */ export interface DescribeGlobalAcceleratorAclRulesRequest { /** *访问控制策略ID。
*/ GlobalAcceleratorAclPolicyId: string; /** *偏移量,默认为0。
*/ Offset?: number; /** *返回数量。
取值范围:[1, 200]
默认值:20
*/ Limit?: number; } /** * DeleteGlobalAcceleratorAclRule返回参数结构体 */ export interface DeleteGlobalAcceleratorAclRuleResponse { /** * 异步任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccessLogParam返回参数结构体 */ export interface DescribeAccessLogParamResponse { /** *七层可选参数
*/ L7Param?: Array四层可选参数
*/ L4Param?: Array异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 七层转发规则行为信息 */ export interface RuleAction { /** *七层转发规则行为类型
枚举值:
七层转发规则行为值
当RuleActionType是Drop时,此字段不用传;当RuleActionType是ForwardGroup时,此字段必传,需要填写的是自定义终端节点组ID, 不支持配置默认终端节点组。
注意:此字段可能返回 null,表示取不到有效值。 */ RuleActionValue?: string; } /** * DeleteEndpointGroups请求参数结构体 */ export interface DeleteEndpointGroupsRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 监听器ID。 */ ListenerId: string; /** * 终端节点组ID。 */ EndpointGroupIds: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *终端节点组ID。
*/ EndpointGroupId: string; /** *终端节点配置。
*/ EndpointConfigurations?: Array名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name?: string; /** *描述信息。
入参限制:最大长度不能超过100个字节。
*/ Description?: string; /** *是否开启健康检查。
*/ EnableHealthCheck?: boolean; /** *响应超时时间。
取值范围:[1, 100]
当开启健康检查时候,此参数必传。
*/ ConnectTimeout?: number; /** *健康检查间隔。
取值范围:[5, 300]
当开启健康检查时,此参数必传。
*/ HealthCheckInterval?: number; /** *不健康阀值。
取值范围:[1, 10]
当开启健康检查时,此字段必传。
*/ UnhealthyThreshold?: number; /** *健康阀值。
取值范围:[1, 10]
当开启健康检查时,此字段必传。
*/ HealthyThreshold?: number; /** *检查协议。
入参限制:支持填写:'TCP', 'HTTP', 'PING', 'CUSTOM'。
1、当监听器是TCP时,可以选CUSTOM+TCP。
2、当监听器是UDP时,可以选PING+CUSTOM。
3、当监听器是HTTP或HTTPS时,可以选HTTP。
检查端口。
取值范围:[1, 65535]
当CheckType是CUSTOM时,此字段必传。
*/ CheckPort?: number; /** *检查内容。
入参限制:仅支持TEXT。
当CheckType是CUSTOM时,此字段必传。
*/ ContextType?: string; /** *检查请求。
入参限制:长度范围在1-500。
当CheckType是CUSTOM时,此字段必传。
*/ CheckSendContext?: string; /** *检查返回结果。
入参限制:长度范围在1-500。
当CheckType是CUSTOM时,此字段必传。
*/ CheckRecvContext?: string; /** *检查域名。
入参限制:长度范围在3-80。
当CheckType是HTTP时,此字段必传。
*/ CheckDomain?: string; /** *检查URL。
入参限制:长度范围在3-80。
当CheckType是HTTP时,此字段必传。
*/ CheckPath?: string; /** *请求方式。
入参限制:支持填写 'GET', 'HEAD'。
当CheckType是HTTP时,此字段必传。
*/ CheckMethod?: string; /** *状态检测码。
入参限制:支持选择'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'。
当CheckType是HTTP时,此字段必传。
*/ StatusMask?: Array回源协议。
入参限制:支持选择:'HTTP', 'HTTPS'。
当监听器协议是HTTP时只能配置HTTP,是HTTPS时能配HTTP或HTTPS。
*/ ForwardProtocol?: string; /** *端口映射。
当监听器协议是HTTP或HTTPS支持配置一对。当监听器协议是UDP或TCP支持配置最多30对。
*/ PortOverrides?: ArrayHPPTS加密算法套件
入参限制:支持选择'tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3'。
当监听器协议是HTTPS时,才支持修改此参数。
*/ CipherPolicyId?: string; /** *仅HTTPS回源协议支持选择['HTTP/1.1', 'HTTP/2']
枚举值:
全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *访问控制策略ID。
*/ GlobalAcceleratorAclPolicyId: string; /** *访问控制策略状态。
枚举值:
全球加速实例ID。
*/ GlobalAcceleratorId?: string; /** *监听器实例ID。
*/ ListenerId?: string; /** *终端节点组ID。
*/ EndpointGroupId?: string; /** *名称。
*/ Name?: string; /** *地域。
*/ EndpointGroupRegion?: string; /** *描述。
*/ Description?: string; /** *终端节点信息。
*/ EndpointConfigurations?: Array是否开启健康检查。
*/ EnableHealthCheck?: boolean; /** *响应超时时间。
*/ ConnectTimeout?: number; /** *健康检查间隔。
*/ HealthCheckInterval?: number; /** *不健康阈值。
*/ UnhealthyThreshold?: number; /** *健康阈值。
*/ HealthyThreshold?: number; /** *检查协议。
*/ CheckType?: string; /** *检查端口。
*/ CheckPort?: number; /** *检查内容。
*/ ContextType?: string; /** *检查请求。
*/ CheckSendContext?: string; /** *检查返回结果。
*/ CheckRecvContext?: string; /** *检查域名。
*/ CheckDomain?: string; /** *检查URL。
*/ CheckPath?: string; /** *请求方式。
*/ CheckMethod?: string; /** *状态检测码。
*/ StatusMask?: Array终端节点组类型。
*/ EndpointGroupType?: string; /** *回源协议。
*/ ForwardProtocol?: string; /** *端口映射信息。
*/ PortOverrides?: Array自定义终端节点组是否绑定七层转发规则。
*/ VirtualExistForwardingRuleFlag?: boolean; /** *出终端节点组公网IP。
*/ OriginPublicIps?: Array运营商类型;中国移动(CMCC),中国联通(CUCC),中国电信(CTCC)。
*/ IspType?: string; /** *HPPTS加密算法套件
*/ CipherPolicyId?: string; /** *仅HTTPS回源协议支持选择['HTTP/1.1', 'HTTP/2']
枚举值:
符合条件的全球加速实例。
*/ GlobalAcceleratorSet?: Array符合条件的实例个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyGlobalAcceleratorAccessLog请求参数结构体 */ export interface ModifyGlobalAcceleratorAccessLogRequest { /** *日志唯一Id
*/ LogPushTaskId: string; /** *GA实例唯一Id
*/ GlobalAcceleratorId: string; /** *日志主题Id
*/ CloudLogId?: string; /** *日志集Id
*/ CloudLogSetId?: string; /** *用户可选日志监听字段
枚举值:
日志描述
*/ FlowLogDescription?: string; } /** * DescribeListeners返回参数结构体 */ export interface DescribeListenersResponse { /** * 符合条件的监听器实例。 */ ListenerSet?: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *域名。
参数格式:格式,必须满足正则表达式:^(a-z0-9?.)+[a-z]{2,}$
入参限制:长度范围是1-80。
*/ Host: string; } /** * DeleteListenerAdditionalCert返回参数结构体 */ export interface DeleteListenerAdditionalCertResponse { /** * 任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Acl信息 */ export interface AclEntries { /** *协议。
入参限制:支持配置'TCP', 'UDP', 'ALL';
*/ Protocol: string; /** *端口。
*/ Port: string; /** *网段。
*/ SourceCidrBlock: string; /** *执行动作。
入参限制:支持配置'ACCEPT', 'DROP';
*/ Policy: string; /** *描述信息,最大长度不能超过100个字节。
*/ Description?: string; } /** * ModifyForwardingPolicy请求参数结构体 */ export interface ModifyForwardingPolicyRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *策略ID。
*/ ForwardingPolicyId: string; /** *域名。
入参限制:长度范围在1-80。
格式必须满足正则表达式:^(a-z0-9?.)+[a-z]{2,}$
*/ Host: string; } /** * DescribeGlobalAcceleratorAccessLog请求参数结构体 */ export interface DescribeGlobalAcceleratorAccessLogRequest { /** *ga实例唯一Id
*/ GlobalAcceleratorId: string; /** *查询过滤参数。{ "Name": "listener-id", "Values": ["监听器唯一Id"] },{ "Name": "endpoint-group-id", "Values": ["终端节点组唯一Id"] },{ "Name": "access_log_id", "Values": ["日志唯一Id"] }
*/ Filters?: Array偏移量,默认为0。
*/ Offset?: number; /** *返回数量。
取值范围:[0, 200]
*/ Limit?: number; } /** * CreateListenerAdditionalCert请求参数结构体 */ export interface CreateListenerAdditionalCertRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *证书ID。
当前只能添加服务器证书。
*/ AdditionalCertificates: Array偏移量,默认为0。
*/ Offset?: number; /** *返回数量。
取值范围:[1, 200]
默认值:20
*/ Limit?: number; /** *过滤条件。
异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 终端节点配置 */ export interface EndpointConfigurations { /** *域名类型。可选值'Domain', 'PublicIp'。
*/ EndpointType: string; /** *域名。
*/ EndpointService: string; /** *权重。
*/ Weight: number; /** *健康检查状态;HEALTH:健康;UNHEALTH:不健康。
*/ HealthCheckStatus?: string; } /** * 端口范围 */ export interface PortRanges { /** * 起始端口。 注意:此字段可能返回 null,表示取不到有效值。 */ FromPort: number; /** * 终点端口。 注意:此字段可能返回 null,表示取不到有效值。 */ ToPort: number; } /** * ModifyGlobalAcceleratorAclPolicy返回参数结构体 */ export interface ModifyGlobalAcceleratorAclPolicyResponse { /** *异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAccessLogStatus请求参数结构体 */ export interface ModifyAccessLogStatusRequest { /** *日志唯一Id
*/ LogPushTaskId: string; /** *状态(启动START, 停止STOP)
枚举值:
GA实例唯一Id
*/ GlobalAcceleratorId: string; } /** * DeleteListener请求参数结构体 */ export interface DeleteListenerRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 监听器ID。 */ ListenerId: string; } /** * CreateGlobalAcceleratorAclPolicy请求参数结构体 */ export interface CreateGlobalAcceleratorAclPolicyRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *默认行为。
枚举值:
日志任务唯一Id
*/ LogPushTaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteEndpointGroups返回参数结构体 */ export interface DeleteEndpointGroupsResponse { /** * 任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccelerateAreas返回参数结构体 */ export interface DescribeAccelerateAreasResponse { /** *加速地域信息。
*/ AccelerateAreaSet?: Array实例个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 终端节点组配置 */ export interface EndpointGroupConfiguration { /** *终端节点组名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name: string; /** *终端节点组所在地域。
*/ EndpointGroupRegion: string; /** *终端节点配置。
*/ EndpointConfigurations: Array检查协议。支持配置'TCP', 'HTTP', 'PING', 'CUSTOM'。
枚举值:
当开启健康检查时此字段必传。
*/ CheckType?: string; /** *描述信息。
默认值:默认值为空,代表不配置描述信息。
最大长度不能超过100个字节。
*/ Description?: string; /** *检查端口。
入参限制:范围是1-65535。
当CheckType为CUSTOM时候,此字段必传。
*/ CheckPort?: string; /** *检查内容。支持配置'TEXT'。
枚举值:
当CheckType为CUSTOM时候,此字段必传。
*/ ContextType?: string; /** *检查请求。
入参限制:字节长度要在1-500范围内。
当CheckType为CUSTOM时候,此字段必传。
*/ CheckSendContext?: string; /** *检查返回结果。
入参限制:字节长度要在1-500范围内。
当CheckType为CUSTOM时候,此字段必传。
*/ CheckRecvContext?: string; /** *是否开启健康检查。
默认值:False
*/ EnableHealthCheck?: boolean; /** *响应超时时间。
取值范围:[1, 100]
默认值:2
开启健康检查时,此字段必传。
*/ ConnectTimeout?: number; /** *健康检查间隔。
取值范围:[5, 300]
默认值:30
开启健康检查,此字段必传。
*/ HealthCheckInterval?: number; /** *不健康阀值。
取值范围:[1, 10]
默认值:3
开启健康检查,此字段必传。
*/ UnhealthyThreshold?: number; /** *健康阈值。
取值范围:[1, 10]
默认值:3
开启健康检查,此字段必传。
*/ HealthyThreshold?: number; /** *回源协议。支持配置'HTTP', 'HTTPS'。
枚举值:
当终端节点组所在监听器协议为HTTP或HTTPS时候,此字段必传。
*/ ForwardProtocol?: string; /** *检查域名。
入参限制:字节长度范围是3-80。
当CheckType是HTTP时,此字段必传。
*/ CheckDomain?: string; /** *检查URL。
参数格式:必须满足正则:^[a-zA-Z0-9_.\-\/]{1,80}$
当CheckType是HTTP时,此字段必传。
*/ CheckPath?: string; /** *请求方式。支持配置'GET', 'HEAD'。
枚举值:
当CheckType是HTTP时,此字段必传。
*/ CheckMethod?: string; /** *状态检测码。支持配置'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'。
枚举值:
当CheckType是HTTP时,此字段必传。
*/ StatusMask?: Array端口映射。
入参限制:七层支持1个端口映射,四层支持最多30个端口映射。
*/ PortOverrides?: Array运营商类型。支持配置'CMCC', 'CTCC', 'CUCC'。
枚举值:
当终端节点组地域为三网地域时,此字段必传。
*/ IspType?: string; /** *HPPTS加密算法套件;支持配置'tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3';
枚举值:
当回源协议为HTTPS,此字段必传。
*/ CipherPolicyId?: string; /** *回源协议。支持配置'HTTP/1.1', 'HTTP/2'。
枚举值:
当回源协议为HTTPS时,此字段必传。
*/ HttpVersion?: string; } /** * 全球加速实例信息 */ export interface GlobalAcceleratorSet { /** *全球加速实例ID。
*/ GlobalAcceleratorId?: string; /** *全球加速实例名称。
*/ Name?: string; /** *全球加速实例描述。
*/ Description?: string; /** *全球加速实例创建时间。
*/ CreateTime?: string; /** *全球加速实例状态。
*/ State?: string; /** *全球加速实例付费类型。
*/ InstanceChargeType?: string; /** *全球加速实例DdosId。
*/ DdosId?: string; /** *所属加速实例监听器个数。
*/ ListenerCounts?: number; /** *所属加速实例加速地域个数。
*/ AcceleratorAreaCounts?: number; /** *全球加速实例状态。
*/ Status?: string; /** *域名。
*/ Cname?: string; /** *跨境类型;HighQuality(精品跨境)、Unicom(联通跨境)、NotAvailable(未开通)。
注意:此字段可能返回 null,表示取不到有效值。 */ CrossBorderType?: string; /** *标签信息。
*/ TagSet?: Array加速地域。
*/ AccelerateRegion: string; /** *带宽。
*/ Bandwidth?: number; /** *支持'BGP', 'QUALITY_BGP', 'STATIC_IP',默认BGP。
枚举值:
仅支持IPv4,默认是IPv4。
*/ IpVersion?: string; /** *加速地域ID。
*/ AcceleratorAreaId?: string; /** *IP。
*/ IpAddress?: ArrayIP信息。
注意:此字段可能返回 null,表示取不到有效值。 */ IpAddressInfoSet?: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *终端节点组类型。
枚举值:
终端节点组配置。
*/ EndpointGroupConfiguration: EndpointGroupConfiguration; } /** * CreateEndpointGroup返回参数结构体 */ export interface CreateEndpointGroupResponse { /** *任务ID。
*/ TaskId?: string; /** *终端节点组实例ID。
*/ EndpointGroupId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlobalAccelerator返回参数结构体 */ export interface DeleteGlobalAcceleratorResponse { /** * 任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGlobalAcceleratorAclRule返回参数结构体 */ export interface CreateGlobalAcceleratorAclRuleResponse { /** * 异步任务ID。 */ TaskId?: string; /** * ACL规则ID。 */ GlobalAcceleratorAclRuleIds?: Array七层转发规则条件信息。
*/ RuleCondition?: Array七层转发规则行为信息。
*/ RuleAction?: Array是否开启回源Sni。
*/ EnableOriginSni?: boolean; /** *回源Sni。
*/ OriginSni?: string; /** *回源Herder信息。
*/ OriginHeaders?: Array回源Host。
*/ OriginHost?: string; /** *全球加速实例ID。
*/ GlobalAcceleratorId?: string; /** *监听器ID。
*/ ListenerId?: string; /** *七层转发策略ID。
*/ ForwardingPolicyId?: string; /** *七层转发规则ID。
*/ ForwardingRuleId?: string; /** *源站响应头
*/ HideResponseHeaders?: Array删除源站响应头
*/ ResponseHeaders?: Array异步任务ID。
*/ TaskId?: string; /** *七层转发规则ID。
*/ ForwardingRuleId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGlobalAcceleratorAclPolicy返回参数结构体 */ export interface CreateGlobalAcceleratorAclPolicyResponse { /** *异步任务ID。
*/ TaskId?: string; /** *访问控制策略ID。
*/ GlobalAcceleratorAclPolicyId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGlobalAcceleratorAccessLog请求参数结构体 */ export interface CreateGlobalAcceleratorAccessLogRequest { /** *GA示例唯一Id
*/ GlobalAcceleratorId: string; /** *监听器Id
*/ ListenerId: string; /** *终端节点组Id
*/ EndpointGroupId: string; /** *日志集所在地域
*/ CloudRegion: string; /** *日志主题Id
*/ CloudLogId: string; /** *日志集Id
*/ CloudLogSetId: string; /** *指定采集字段
枚举值:
日志描述
*/ FlowLogDescription?: string; } /** * ModifyGlobalAcceleratorAclRule请求参数结构体 */ export interface ModifyGlobalAcceleratorAclRuleRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *安全策略ID
*/ GlobalAcceleratorAclPolicyId: string; /** *Acl规则ID。
*/ GlobalAcceleratorAclRuleId: string; /** *协议。
入参限制:支持选择'TCP', 'UDP'。
*/ Protocol?: string; /** *端口。
*/ Port?: string; /** *网段。
*/ SourceCidrBlock?: string; /** *动作。
入参限制:支持选择'ACCEPT', 'DROP'。
枚举值:
描述信息,最大长度不能超过100个字节。
*/ Description?: string; } /** * 可加速地域信息 */ export interface AcceleratorRegionSet { /** *地域中文名称。
*/ Name?: string; /** *是否可用;0:不可用,1:可用。
*/ IsAvailable?: number; /** *地域信息。
*/ Region?: string; /** *地区名称。
*/ AreaName?: string; /** *是否中国地域。
*/ IsChinaMainland?: number; /** *支持IspType类型。
*/ SupportIspType?: Array是否腾讯地域。
*/ IsTencentRegion?: number; } /** * CreateListener返回参数结构体 */ export interface CreateListenerResponse { /** *任务ID。
*/ TaskId?: string; /** *监听器ID。
*/ ListenerId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyForwardingPolicy返回参数结构体 */ export interface ModifyForwardingPolicyResponse { /** *异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGlobalAcceleratorAclRule请求参数结构体 */ export interface CreateGlobalAcceleratorAclRuleRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 安全策略ID */ GlobalAcceleratorAclPolicyId: string; /** * Acl信息。 */ AclEntries: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name?: string; /** *描述信息,最大长度不能超过100个字节。
*/ Description?: string; /** *连接空闲等待时间。
1、HTTP/HTTPS监听器,支持范围为1-60;2、TCP监听器,支持范围为10-900;3、UDP监听器,支持范围为10-20;
*/ IdleTimeout?: number; /** *是否开启会话保持。
枚举值:
TCP/UDP监听器支持修改此参数。
*/ ClientAffinity?: string; /** *会话保持时间。
取值范围:[60, 3600]
*/ ClientAffinityTime?: number; /** *请求超时时间。
取值范围:[1, 180]
HTTPS监听器才支持此参数修改。
*/ RequestTimeout?: number; /** *是否打开七层获取源IP方式。
HTTPS/HTTP监听器才支持此参数修改。
*/ XForwardedForRealIp?: boolean; /** *解析方式。
枚举值:
HTTPS/HTTP监听器才支持修改此参数。
*/ CertificationType?: string; /** *加密算法套件。
入参限制:支持选择tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3'。
HTTPS监听器才支持此参数修改。
*/ CipherPolicyId?: string; /** *服务器证书。
入参限制:当前仅支持传入一本证书;如果要使用多本证书,使用证书接口CreateListenerAdditionalCert来加其他证书。
HTTPS监听器才支持此参数修改。
*/ ServerCertificates?: Array客户端证书。
入参限制:1、当前仅支持传入一本证书;如果要使用多本证书,使用证书接口CreateListenerAdditionalCert来加其他证书。2、证书必须为CA证书。
HTTPS监听器才支持此参数修改,并且开启双向认证。
*/ ClientCaCertificates?: Array获取源IP方式。
入参限制:支持选择'ProxyProtocol', 'Close', 'ProxyProtocolV2', 'TOA'。
TCP监听器才支持此参数修改。
*/ GetRealIpType?: string; } /** * 七层转发规则条件信息 */ export interface RuleCondition { /** *七层转发规则条件类型
枚举值:
七层转发规则条件值
参数格式:格式必须满足正则表达:^[a-zA-Z0-9_.-/]{1,80}$
数组长度不能超过1。
注意:此字段可能返回 null,表示取不到有效值。 */ RuleConditionValue: Arraykey
参数格式:1、字符串只包含可打印的ASCII字符 2、不能包含这些字符()<>@,;:\"/[ ]?={ }
入参限制:长度在1-40。
*/ Key: string; /** *value
当前仅支持传空字符串""
*/ Value: string; } /** * DescribeForwardingRule返回参数结构体 */ export interface DescribeForwardingRuleResponse { /** * 符合条件的规则信息。 */ ForwardingRuleSet?: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *监听器ID。
*/ ListenerId: string; /** *策略ID。
*/ ForwardingPolicyId: string; /** *七层转发规则ID。
*/ ForwardingRuleId: string; /** *七层转发规则条件信息。
入参限制:数组长度不能超过1。
*/ RuleConditions?: Array七层转发规则行为信息。
入参限制:数组长度不能超过1。
*/ RuleActions?: Array回源Header信息。
入参限制:数组长度在1-5。
*/ OriginHeaders?: Array是否开启回源sni。
*/ EnableOriginSni?: boolean; /** *回源sni。
入参限制:长度不能超过80。
当开启回源sni时,此字段必传。
*/ OriginSni?: string; /** *回源host。
入参限制:长度不能超过80。
当开启回源sni时,此字段必传。
*/ OriginHost?: string; /** *源站响应头
入参限制:数组长度不能超过5。
*/ ResponseHeaders?: Array删除源站响应头
入参限制:数组长度不能超过5。
*/ HideResponseHeaders?: Array任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlobalAcceleratorAccessLog返回参数结构体 */ export interface DeleteGlobalAcceleratorAccessLogResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteForwardingPolicy请求参数结构体 */ export interface DeleteForwardingPolicyRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 监听器ID。 */ ListenerId: string; /** * 策略ID。 */ ForwardingPolicyId: string; } /** * CreateListener请求参数结构体 */ export interface CreateListenerRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name: string; /** *端口范围。
*/ PortRanges: PortRanges; /** *描述信息,最大长度不能超过100个字符。
*/ Description?: string; /** *监听类型,默认为智能路由。
枚举值:
协议,默认为TCP。支持配置'TCP', 'UDP', 'HTTP', 'HTTPS'。
*/ Protocol?: string; /** *连接空闲等待时间。
1、HTTP/HTTPS监听器,默认值为15,支持范围为1-60;
2、TCP监听器,默认值为900,支持范围为10-900;
3、UDP监听器,默认值为20,支持范围为10-20;
四层获取源IP方式,支持'TOA', 'ProxyProtocol', 'ProxyProtocolV2'。
需要开启四层获取源IP方式,才填写此参数。
*/ GetRealIpType?: string; /** *是否开启会话保持。支持配置'Open', 'Close'。
枚举值:
仅支持4层监听器 ,7层不支持修改
*/ ClientAffinity?: string; /** *请求超时时间。
取值范围:[1, 180]
默认值:60
当HTTPS监听器时才可配置此参数。
*/ RequestTimeout?: number; /** *是否打开七层获取源IP方式。
*/ XForwardedForRealIp?: boolean; /** *解析方式。
枚举值:
HTTPS监听器,此字段必传。
*/ CertificationType?: string; /** *加密算法套件。支持配置'tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3'。
*/ CipherPolicyId?: string; /** *服务器证书。
入参限制:当前仅支持传入一本证书;如果要使用多本证书,使用证书接口CreateListenerAdditionalCert来加其他证书。
当是HTTPS监听器时,此字段必传。
*/ ServerCertificates?: Array客户端证书。
入参限制:1、当前仅支持传入一本证书;如果要使用多本证书,使用证书接口CreateListenerAdditionalCert来加其他证书。2、证书必须为CA证书。
当时HTTPS监听器且开启双向认证时,此字段必传。
*/ ClientCaCertificates?: ArrayHTTPS监听器支持选择版本
枚举值:
全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *名称。
参数格式:以字母或中文开头,长度 2–128 个字符,支持字母、数字、中文、. - _
*/ Name?: string; /** *描述信息。
参数格式:最大长度不超过100 个字符。
*/ Description?: string; /** *跨境类型。
枚举值:
代表是否填写跨境服务承诺书。
当CrossBorderType传入时,此字段必须填ture,代表填写跨境承诺书。
*/ CrossBorderPromiseFlag?: boolean; } /** * 过滤器 */ export interface Filter { /** * 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 */ Name: string; /** * 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。当值类型为布尔类型时,可直接取值为字符串"TRUE"或 "FALSE"。 */ Values: Array异步任务ID。
*/ TaskId?: string; /** *七层转发策略ID。
*/ ForwardingPolicyId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 七层转发策略信息 */ export interface ForwardingPolicySet { /** * 全球加速实例ID。 */ GlobalAcceleratorId?: string; /** * 监听器ID。 */ ListenerId?: string; /** * 策略ID。 */ ForwardingPolicyId?: string; /** * 域名。 */ Host?: string; /** * 是否为默认域名。 */ DefaultHostFlag?: boolean; } /** * ModifyGlobalAcceleratorAclRule返回参数结构体 */ export interface ModifyGlobalAcceleratorAclRuleResponse { /** *异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 加速地域公网IP信息 */ export interface IpAddressInfoSet { /** *IP地址。
*/ IpAddress?: string; /** *IP类型。
*/ IspType?: string; /** *Ddos类型
*/ DdosProtectionType?: string; } /** * DeleteForwardingPolicy返回参数结构体 */ export interface DeleteForwardingPolicyResponse { /** * 异步任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyEndpointGroup返回参数结构体 */ export interface ModifyEndpointGroupResponse { /** *任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 监听器信息 */ export interface ListenerSet { /** * 全球加速实例ID。 */ GlobalAcceleratorId?: string; /** * 监听器ID。 */ ListenerId?: string; /** * 监听器名称。 */ Name?: string; /** * 监听器描述。 */ Description?: string; /** * 协议。 */ Protocol?: string; /** * 端口范围。 */ PortRanges?: PortRanges; /** * 是否打开七层获取源IP方式。 */ XForwardedForRealIp?: boolean; /** * 开启会话保持。 */ ClientAffinity?: string; /** * 会话保持时间。 */ ClientAffinityTime?: number; /** * SSL解析方式。 */ CertificationType?: string; /** * 服务器证书。 */ ServerCertificates?: Array符合条件的Acl规则实例。
*/ GlobalAcceleratorAclRuleSet?: Array符合条件的实例个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GA访问日志 */ export type GlobalAcceleratorAccessLog = null; /** * ModifyAccessLogStatus返回参数结构体 */ export interface ModifyAccessLogStatusResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccelerateAreas请求参数结构体 */ export interface DescribeAccelerateAreasRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *偏移量。默认为0。
*/ Offset?: number; /** *符合条件实例数量。默认为20,最大200。
*/ Limit?: number; /** *过滤条件。 accelerate-region- String -(过滤条件)终端节点组地域。
*/ Filters?: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *加速地域信息。一次最多创建10组加速地域。
*/ AcceleratorAreas: Array全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *偏移量。默认值为0。
*/ Offset?: number; /** *返回数量,默认值为20,最大值为200。
*/ Limit?: string; } /** * DescribeGlobalAcceleratorAclPolicies返回参数结构体 */ export interface DescribeGlobalAcceleratorAclPoliciesResponse { /** *访问控制策略信息。
*/ GlobalAcceleratorAclPolicySet?: Array符合条件实例总个数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyForwardingRule返回参数结构体 */ export interface ModifyForwardingRuleResponse { /** *异步任务ID。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAccelerateAreas请求参数结构体 */ export interface ModifyAccelerateAreasRequest { /** *全球加速实例ID。
*/ GlobalAcceleratorId: string; /** *加速地域信息。
入参限制:数组长度不能超过10。
*/ AcceleratorAreas: Array任务ID。
*/ TaskId?: string; /** *全球加速实例ID。
*/ GlobalAcceleratorId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeListeners请求参数结构体 */ export interface DescribeListenersRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 偏移量,默认为0。 */ Offset?: number; /** * 返回数量,默认为20,最大值为100。 */ Limit?: number; /** * 过滤条件。 listener-id- String -(过滤条件)监听器实例ID。 */ Filters?: Array键。
参数格式:1、字符串只包含可打印的ASCII字符 2、不能包含这些字符()<>@,;:\"/[ ]?={ }
入参限制:长度在1-40。
注意:此字段可能返回 null,表示取不到有效值。 */ Key: string; /** *值。
入参限制:长度不能超过128
如果字符串包含$,那仅能配置'$remote_addr', '$remote_port',否则不支持。
注意:此字段可能返回 null,表示取不到有效值。 */ Value: string; } /** * DeleteListener返回参数结构体 */ export interface DeleteListenerResponse { /** * 任务ID。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlobalAcceleratorAclPolicy请求参数结构体 */ export interface DeleteGlobalAcceleratorAclPolicyRequest { /** * 全球加速实例ID。 */ GlobalAcceleratorId: string; /** * 访问控制策略ID。 */ GlobalAcceleratorAclPolicyId: string; } /** * DescribeAccessLogParam请求参数结构体 */ export type DescribeAccessLogParamRequest = null; /** * 端口映射 */ export interface PortOverride { /** * 监听端口。 注意:此字段可能返回 null,表示取不到有效值。 */ ListenerPort: number; /** * 映射端口。 注意:此字段可能返回 null,表示取不到有效值。 */ EndpointPort: number; }