Class: TencentCloud::Apigateway::V20180808::ModifyApiRequest

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Apigateway::V20180808::ModifyApiRequest

show all

Defined in:: lib/v20180808/models.rb

Overview

ModifyApi请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

#deserialize(params) ⇒ Object
#initialize(serviceid = nil, servicetype = nil, requestconfig = nil, apiid = nil, apiname = nil, apidesc = nil, apitype = nil, authtype = nil, authrequired = nil, servicetimeout = nil, protocol = nil, enablecors = nil, constantparameters = nil, requestparameters = nil, apibusinesstype = nil, servicemockreturnmessage = nil, microservices = nil, servicetsfloadbalanceconf = nil, servicetsfhealthcheckconf = nil, targetservicesloadbalanceconf = nil, targetserviceshealthcheckconf = nil, servicescffunctionname = nil, servicewebsocketregisterfunctionname = nil, servicewebsocketcleanupfunctionname = nil, servicewebsockettransportfunctionname = nil, servicescffunctionnamespace = nil, servicescffunctionqualifier = nil, servicewebsocketregisterfunctionnamespace = nil, servicewebsocketregisterfunctionqualifier = nil, servicewebsockettransportfunctionnamespace = nil, servicewebsockettransportfunctionqualifier = nil, servicewebsocketcleanupfunctionnamespace = nil, servicewebsocketcleanupfunctionqualifier = nil, servicescfisintegratedresponse = nil, isdebugaftercharge = nil, tagspecifications = nil, isdeleteresponseerrorcodes = nil, responsetype = nil, responsesuccessexample = nil, responsefailexample = nil, serviceconfig = nil, authrelationapiid = nil, serviceparameters = nil, oauthconfig = nil, responseerrorcodes = nil, isbase64encoded = nil, isbase64trigger = nil, base64encodedtriggerrules = nil, eventbusid = nil, servicescffunctiontype = nil, servicescfeventisasynccall = nil, eiamapptype = nil, eiamauthtype = nil, eiamappid = nil, tokentimeout = nil) ⇒ ModifyApiRequest constructor

A new instance of ModifyApiRequest.

Constructor Details

#initialize(serviceid = nil, servicetype = nil, requestconfig = nil, apiid = nil, apiname = nil, apidesc = nil, apitype = nil, authtype = nil, authrequired = nil, servicetimeout = nil, protocol = nil, enablecors = nil, constantparameters = nil, requestparameters = nil, apibusinesstype = nil, servicemockreturnmessage = nil, microservices = nil, servicetsfloadbalanceconf = nil, servicetsfhealthcheckconf = nil, targetservicesloadbalanceconf = nil, targetserviceshealthcheckconf = nil, servicescffunctionname = nil, servicewebsocketregisterfunctionname = nil, servicewebsocketcleanupfunctionname = nil, servicewebsockettransportfunctionname = nil, servicescffunctionnamespace = nil, servicescffunctionqualifier = nil, servicewebsocketregisterfunctionnamespace = nil, servicewebsocketregisterfunctionqualifier = nil, servicewebsockettransportfunctionnamespace = nil, servicewebsockettransportfunctionqualifier = nil, servicewebsocketcleanupfunctionnamespace = nil, servicewebsocketcleanupfunctionqualifier = nil, servicescfisintegratedresponse = nil, isdebugaftercharge = nil, tagspecifications = nil, isdeleteresponseerrorcodes = nil, responsetype = nil, responsesuccessexample = nil, responsefailexample = nil, serviceconfig = nil, authrelationapiid = nil, serviceparameters = nil, oauthconfig = nil, responseerrorcodes = nil, isbase64encoded = nil, isbase64trigger = nil, base64encodedtriggerrules = nil, eventbusid = nil, servicescffunctiontype = nil, servicescfeventisasynccall = nil, eiamapptype = nil, eiamauthtype = nil, eiamappid = nil, tokentimeout = nil) ⇒ `ModifyApiRequest`

Returns a new instance of ModifyApiRequest.

# File 'lib/v20180808/models.rb', line 7347

def initialize(serviceid=nil, servicetype=nil, requestconfig=nil, apiid=nil, apiname=nil, apidesc=nil, apitype=nil, authtype=nil, authrequired=nil, servicetimeout=nil, protocol=nil, enablecors=nil, constantparameters=nil, requestparameters=nil, apibusinesstype=nil, servicemockreturnmessage=nil, microservices=nil, servicetsfloadbalanceconf=nil, servicetsfhealthcheckconf=nil, targetservicesloadbalanceconf=nil, targetserviceshealthcheckconf=nil, servicescffunctionname=nil, servicewebsocketregisterfunctionname=nil, servicewebsocketcleanupfunctionname=nil, servicewebsockettransportfunctionname=nil, servicescffunctionnamespace=nil, servicescffunctionqualifier=nil, servicewebsocketregisterfunctionnamespace=nil, servicewebsocketregisterfunctionqualifier=nil, servicewebsockettransportfunctionnamespace=nil, servicewebsockettransportfunctionqualifier=nil, servicewebsocketcleanupfunctionnamespace=nil, servicewebsocketcleanupfunctionqualifier=nil, servicescfisintegratedresponse=nil, isdebugaftercharge=nil, tagspecifications=nil, isdeleteresponseerrorcodes=nil, responsetype=nil, responsesuccessexample=nil, responsefailexample=nil, serviceconfig=nil, authrelationapiid=nil, serviceparameters=nil, oauthconfig=nil, responseerrorcodes=nil, isbase64encoded=nil, isbase64trigger=nil, base64encodedtriggerrules=nil, eventbusid=nil, servicescffunctiontype=nil, servicescfeventisasynccall=nil, eiamapptype=nil, eiamauthtype=nil, eiamappid=nil, tokentimeout=nil)
  @ServiceId = serviceid
  @ServiceType = servicetype
  @RequestConfig = requestconfig
  @ApiId = apiid
  @ApiName = apiname
  @ApiDesc = apidesc
  @ApiType = apitype
  @AuthType = authtype
  @AuthRequired = authrequired
  @ServiceTimeout = servicetimeout
  @Protocol = protocol
  @EnableCORS = enablecors
  @ConstantParameters = constantparameters
  @RequestParameters = requestparameters
  @ApiBusinessType = apibusinesstype
  @ServiceMockReturnMessage = servicemockreturnmessage
  @MicroServices = microservices
  @ServiceTsfLoadBalanceConf = servicetsfloadbalanceconf
  @ServiceTsfHealthCheckConf = servicetsfhealthcheckconf
  @TargetServicesLoadBalanceConf = targetservicesloadbalanceconf
  @TargetServicesHealthCheckConf = targetserviceshealthcheckconf
  @ServiceScfFunctionName = servicescffunctionname
  @ServiceWebsocketRegisterFunctionName = servicewebsocketregisterfunctionname
  @ServiceWebsocketCleanupFunctionName = servicewebsocketcleanupfunctionname
  @ServiceWebsocketTransportFunctionName = servicewebsockettransportfunctionname
  @ServiceScfFunctionNamespace = servicescffunctionnamespace
  @ServiceScfFunctionQualifier = servicescffunctionqualifier
  @ServiceWebsocketRegisterFunctionNamespace = servicewebsocketregisterfunctionnamespace
  @ServiceWebsocketRegisterFunctionQualifier = servicewebsocketregisterfunctionqualifier
  @ServiceWebsocketTransportFunctionNamespace = servicewebsockettransportfunctionnamespace
  @ServiceWebsocketTransportFunctionQualifier = servicewebsockettransportfunctionqualifier
  @ServiceWebsocketCleanupFunctionNamespace = servicewebsocketcleanupfunctionnamespace
  @ServiceWebsocketCleanupFunctionQualifier = servicewebsocketcleanupfunctionqualifier
  @ServiceScfIsIntegratedResponse = servicescfisintegratedresponse
  @IsDebugAfterCharge = isdebugaftercharge
  @TagSpecifications = tagspecifications
  @IsDeleteResponseErrorCodes = isdeleteresponseerrorcodes
  @ResponseType = responsetype
  @ResponseSuccessExample = responsesuccessexample
  @ResponseFailExample = responsefailexample
  @ServiceConfig = serviceconfig
  @AuthRelationApiId = authrelationapiid
  @ServiceParameters = serviceparameters
  @OauthConfig = oauthconfig
  @ResponseErrorCodes = responseerrorcodes
  @IsBase64Encoded = isbase64encoded
  @IsBase64Trigger = isbase64trigger
  @Base64EncodedTriggerRules = base64encodedtriggerrules
  @EventBusId = eventbusid
  @ServiceScfFunctionType = servicescffunctiontype
  @ServiceScfEventIsAsyncCall = servicescfeventisasynccall
  @EIAMAppType = eiamapptype
  @EIAMAuthType = eiamauthtype
  @EIAMAppId = eiamappid
  @TokenTimeout = tokentimeout
end

Instance Attribute Details

#ApiBusinessType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ApiBusinessType
  @ApiBusinessType
end

#ApiDesc ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ApiDesc
  @ApiDesc
end

#ApiId ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ApiId
  @ApiId
end

#ApiName ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ApiName
  @ApiName
end

#ApiType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ApiType
  @ApiType
end

#AuthRelationApiId ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def AuthRelationApiId
  @AuthRelationApiId
end

#AuthRequired ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def AuthRequired
  @AuthRequired
end

#AuthType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def AuthType
  @AuthType
end

#Base64EncodedTriggerRules ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def Base64EncodedTriggerRules
  @Base64EncodedTriggerRules
end

#ConstantParameters ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ConstantParameters
  @ConstantParameters
end

#EIAMAppId ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def EIAMAppId
  @EIAMAppId
end

#EIAMAppType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def EIAMAppType
  @EIAMAppType
end

#EIAMAuthType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def EIAMAuthType
  @EIAMAuthType
end

#EnableCORS ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def EnableCORS
  @EnableCORS
end

#EventBusId ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def EventBusId
  @EventBusId
end

#IsBase64Encoded ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def IsBase64Encoded
  @IsBase64Encoded
end

#IsBase64Trigger ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def IsBase64Trigger
  @IsBase64Trigger
end

#IsDebugAfterCharge ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def IsDebugAfterCharge
  @IsDebugAfterCharge
end

#IsDeleteResponseErrorCodes ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def IsDeleteResponseErrorCodes
  @IsDeleteResponseErrorCodes
end

#MicroServices ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def MicroServices
  @MicroServices
end

#OauthConfig ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def OauthConfig
  @OauthConfig
end

#Protocol ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def Protocol
  @Protocol
end

#RequestConfig ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def RequestConfig
  @RequestConfig
end

#RequestParameters ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def RequestParameters
  @RequestParameters
end

#ResponseErrorCodes ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ResponseErrorCodes
  @ResponseErrorCodes
end

#ResponseFailExample ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ResponseFailExample
  @ResponseFailExample
end

#ResponseSuccessExample ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ResponseSuccessExample
  @ResponseSuccessExample
end

#ResponseType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ResponseType
  @ResponseType
end

#ServiceConfig ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceConfig
  @ServiceConfig
end

#ServiceId ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceId
  @ServiceId
end

#ServiceMockReturnMessage ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceMockReturnMessage
  @ServiceMockReturnMessage
end

#ServiceParameters ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceParameters
  @ServiceParameters
end

#ServiceScfEventIsAsyncCall ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfEventIsAsyncCall
  @ServiceScfEventIsAsyncCall
end

#ServiceScfFunctionName ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfFunctionName
  @ServiceScfFunctionName
end

#ServiceScfFunctionNamespace ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfFunctionNamespace
  @ServiceScfFunctionNamespace
end

#ServiceScfFunctionQualifier ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfFunctionQualifier
  @ServiceScfFunctionQualifier
end

#ServiceScfFunctionType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfFunctionType
  @ServiceScfFunctionType
end

#ServiceScfIsIntegratedResponse ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceScfIsIntegratedResponse
  @ServiceScfIsIntegratedResponse
end

#ServiceTimeout ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceTimeout
  @ServiceTimeout
end

#ServiceTsfHealthCheckConf ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceTsfHealthCheckConf
  @ServiceTsfHealthCheckConf
end

#ServiceTsfLoadBalanceConf ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceTsfLoadBalanceConf
  @ServiceTsfLoadBalanceConf
end

#ServiceType ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceType
  @ServiceType
end

#ServiceWebsocketCleanupFunctionName ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketCleanupFunctionName
  @ServiceWebsocketCleanupFunctionName
end

#ServiceWebsocketCleanupFunctionNamespace ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketCleanupFunctionNamespace
  @ServiceWebsocketCleanupFunctionNamespace
end

#ServiceWebsocketCleanupFunctionQualifier ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketCleanupFunctionQualifier
  @ServiceWebsocketCleanupFunctionQualifier
end

#ServiceWebsocketRegisterFunctionName ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketRegisterFunctionName
  @ServiceWebsocketRegisterFunctionName
end

#ServiceWebsocketRegisterFunctionNamespace ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketRegisterFunctionNamespace
  @ServiceWebsocketRegisterFunctionNamespace
end

#ServiceWebsocketRegisterFunctionQualifier ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketRegisterFunctionQualifier
  @ServiceWebsocketRegisterFunctionQualifier
end

#ServiceWebsocketTransportFunctionName ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketTransportFunctionName
  @ServiceWebsocketTransportFunctionName
end

#ServiceWebsocketTransportFunctionNamespace ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketTransportFunctionNamespace
  @ServiceWebsocketTransportFunctionNamespace
end

#ServiceWebsocketTransportFunctionQualifier ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def ServiceWebsocketTransportFunctionQualifier
  @ServiceWebsocketTransportFunctionQualifier
end

#TagSpecifications ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def TagSpecifications
  @TagSpecifications
end

#TargetServicesHealthCheckConf ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def TargetServicesHealthCheckConf
  @TargetServicesHealthCheckConf
end

#TargetServicesLoadBalanceConf ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def TargetServicesLoadBalanceConf
  @TargetServicesLoadBalanceConf
end

#TokenTimeout ⇒ `Object`

Parameters:

ServiceId: —

API 所在的服务唯一 ID。
ServiceType: —

API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。
RequestConfig: —

请求的前端配置。
ApiId: —

API 接口唯一 ID。
ApiName: —

用户自定义的 API 名称。
ApiDesc: —

用户自定义的 API 接口描述。
ApiType: —

API 类型，支持NORMAL和TSF，默认为NORMAL。
AuthType: —

API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthRequired: —

是否需要签名认证，True 表示需要，False 表示不需要。待废弃。
ServiceTimeout: —

API 的后端服务超时时间，单位是秒。
Protocol: —

API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
EnableCORS: —

是否需要开启跨域，Ture 表示需要，False 表示不需要。
ConstantParameters: —

常量参数。
RequestParameters: —

前端请求参数。
ApiBusinessType: —

当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。
ServiceMockReturnMessage: —

API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。
MicroServices: —

API绑定微服务列表。
ServiceTsfLoadBalanceConf: —

微服务的负载均衡配置。
ServiceTsfHealthCheckConf: —

微服务的健康检查配置。
TargetServicesLoadBalanceConf: —

target类型负载均衡配置。（内测阶段）
TargetServicesHealthCheckConf: —

target健康检查配置。（内测阶段）
ServiceScfFunctionName: —

scf 函数名称。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName: —

scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName: —

scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName: —

scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfFunctionNamespace: —

scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionQualifier: —

scf函数版本。当后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace: —

scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace: —

scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier: —

scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace: —

scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier: —

scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceScfIsIntegratedResponse: —

是否开启响应集成。当后端类型是SCF时生效。
IsDebugAfterCharge: —

开始调试后计费。（云市场预留字段）
TagSpecifications: —

标签。
IsDeleteResponseErrorCodes: —

是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。
ResponseType: —

返回类型。
ResponseSuccessExample: —

自定义响应配置成功响应示例。
ResponseFailExample: —

自定义响应配置失败响应示例。
ServiceConfig: —

API 的后端服务配置。
AuthRelationApiId: —

关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
ServiceParameters: —

API的后端服务参数。
OauthConfig: —

oauth配置。当AuthType是OAUTH时生效。
ResponseErrorCodes: —

用户自定义错误码配置。
IsBase64Encoded: —

是否开启Base64编码，只有后端为scf时才会生效。
IsBase64Trigger: —

是否开启Base64编码的header触发，只有后端为scf时才会生效。
Base64EncodedTriggerRules: —

Header触发规则，总规则数不能超过10。
EventBusId: —

事件总线ID。
ServiceScfFunctionType: —

scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。
ServiceScfEventIsAsyncCall: —

是否开启SCF Event异步调用。
EIAMAppType: —

EIAM应用类型。
EIAMAuthType: —

EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。
EIAMAppId: —

EIAM应用Token 有效时间，单位为秒，默认为7200秒。
TokenTimeout: —

EIAM应用ID。



7345
7346
7347

# File 'lib/v20180808/models.rb', line 7345

def TokenTimeout
  @TokenTimeout
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20180808/models.rb', line 7405

def deserialize(params)
  @ServiceId = params['ServiceId']
  @ServiceType = params['ServiceType']
  unless params['RequestConfig'].nil?
    @RequestConfig = RequestConfig.new
    @RequestConfig.deserialize(params['RequestConfig'])
  end
  @ApiId = params['ApiId']
  @ApiName = params['ApiName']
  @ApiDesc = params['ApiDesc']
  @ApiType = params['ApiType']
  @AuthType = params['AuthType']
  @AuthRequired = params['AuthRequired']
  @ServiceTimeout = params['ServiceTimeout']
  @Protocol = params['Protocol']
  @EnableCORS = params['EnableCORS']
  unless params['ConstantParameters'].nil?
    @ConstantParameters = []
    params['ConstantParameters'].each do |i|
      constantparameter_tmp = ConstantParameter.new
      constantparameter_tmp.deserialize(i)
      @ConstantParameters << constantparameter_tmp
    end
  end
  unless params['RequestParameters'].nil?
    @RequestParameters = []
    params['RequestParameters'].each do |i|
      reqparameter_tmp = ReqParameter.new
      reqparameter_tmp.deserialize(i)
      @RequestParameters << reqparameter_tmp
    end
  end
  @ApiBusinessType = params['ApiBusinessType']
  @ServiceMockReturnMessage = params['ServiceMockReturnMessage']
  unless params['MicroServices'].nil?
    @MicroServices = []
    params['MicroServices'].each do |i|
      microservicereq_tmp = MicroServiceReq.new
      microservicereq_tmp.deserialize(i)
      @MicroServices << microservicereq_tmp
    end
  end
  unless params['ServiceTsfLoadBalanceConf'].nil?
    @ServiceTsfLoadBalanceConf = TsfLoadBalanceConfResp.new
    @ServiceTsfLoadBalanceConf.deserialize(params['ServiceTsfLoadBalanceConf'])
  end
  unless params['ServiceTsfHealthCheckConf'].nil?
    @ServiceTsfHealthCheckConf = HealthCheckConf.new
    @ServiceTsfHealthCheckConf.deserialize(params['ServiceTsfHealthCheckConf'])
  end
  @TargetServicesLoadBalanceConf = params['TargetServicesLoadBalanceConf']
  unless params['TargetServicesHealthCheckConf'].nil?
    @TargetServicesHealthCheckConf = HealthCheckConf.new
    @TargetServicesHealthCheckConf.deserialize(params['TargetServicesHealthCheckConf'])
  end
  @ServiceScfFunctionName = params['ServiceScfFunctionName']
  @ServiceWebsocketRegisterFunctionName = params['ServiceWebsocketRegisterFunctionName']
  @ServiceWebsocketCleanupFunctionName = params['ServiceWebsocketCleanupFunctionName']
  @ServiceWebsocketTransportFunctionName = params['ServiceWebsocketTransportFunctionName']
  @ServiceScfFunctionNamespace = params['ServiceScfFunctionNamespace']
  @ServiceScfFunctionQualifier = params['ServiceScfFunctionQualifier']
  @ServiceWebsocketRegisterFunctionNamespace = params['ServiceWebsocketRegisterFunctionNamespace']
  @ServiceWebsocketRegisterFunctionQualifier = params['ServiceWebsocketRegisterFunctionQualifier']
  @ServiceWebsocketTransportFunctionNamespace = params['ServiceWebsocketTransportFunctionNamespace']
  @ServiceWebsocketTransportFunctionQualifier = params['ServiceWebsocketTransportFunctionQualifier']
  @ServiceWebsocketCleanupFunctionNamespace = params['ServiceWebsocketCleanupFunctionNamespace']
  @ServiceWebsocketCleanupFunctionQualifier = params['ServiceWebsocketCleanupFunctionQualifier']
  @ServiceScfIsIntegratedResponse = params['ServiceScfIsIntegratedResponse']
  @IsDebugAfterCharge = params['IsDebugAfterCharge']
  unless params['TagSpecifications'].nil?
    @TagSpecifications = Tag.new
    @TagSpecifications.deserialize(params['TagSpecifications'])
  end
  @IsDeleteResponseErrorCodes = params['IsDeleteResponseErrorCodes']
  @ResponseType = params['ResponseType']
  @ResponseSuccessExample = params['ResponseSuccessExample']
  @ResponseFailExample = params['ResponseFailExample']
  unless params['ServiceConfig'].nil?
    @ServiceConfig = ServiceConfig.new
    @ServiceConfig.deserialize(params['ServiceConfig'])
  end
  @AuthRelationApiId = params['AuthRelationApiId']
  unless params['ServiceParameters'].nil?
    @ServiceParameters = []
    params['ServiceParameters'].each do |i|
      serviceparameter_tmp = ServiceParameter.new
      serviceparameter_tmp.deserialize(i)
      @ServiceParameters << serviceparameter_tmp
    end
  end
  unless params['OauthConfig'].nil?
    @OauthConfig = OauthConfig.new
    @OauthConfig.deserialize(params['OauthConfig'])
  end
  unless params['ResponseErrorCodes'].nil?
    @ResponseErrorCodes = []
    params['ResponseErrorCodes'].each do |i|
      responseerrorcodereq_tmp = ResponseErrorCodeReq.new
      responseerrorcodereq_tmp.deserialize(i)
      @ResponseErrorCodes << responseerrorcodereq_tmp
    end
  end
  @IsBase64Encoded = params['IsBase64Encoded']
  @IsBase64Trigger = params['IsBase64Trigger']
  unless params['Base64EncodedTriggerRules'].nil?
    @Base64EncodedTriggerRules = []
    params['Base64EncodedTriggerRules'].each do |i|
      base64encodedtriggerrule_tmp = Base64EncodedTriggerRule.new
      base64encodedtriggerrule_tmp.deserialize(i)
      @Base64EncodedTriggerRules << base64encodedtriggerrule_tmp
    end
  end
  @EventBusId = params['EventBusId']
  @ServiceScfFunctionType = params['ServiceScfFunctionType']
  @ServiceScfEventIsAsyncCall = params['ServiceScfEventIsAsyncCall']
  @EIAMAppType = params['EIAMAppType']
  @EIAMAuthType = params['EIAMAuthType']
  @EIAMAppId = params['EIAMAppId']
  @TokenTimeout = params['TokenTimeout']
end

Class: TencentCloud::Apigateway::V20180808::ModifyApiRequest

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#ApiBusinessType ⇒ Object

#ApiDesc ⇒ Object

#ApiId ⇒ Object

#ApiName ⇒ Object

#ApiType ⇒ Object

#AuthRelationApiId ⇒ Object

#AuthRequired ⇒ Object

#AuthType ⇒ Object

#Base64EncodedTriggerRules ⇒ Object

#ConstantParameters ⇒ Object

#EIAMAppId ⇒ Object

#EIAMAppType ⇒ Object

#EIAMAuthType ⇒ Object

#EnableCORS ⇒ Object

#EventBusId ⇒ Object

#IsBase64Encoded ⇒ Object

#IsBase64Trigger ⇒ Object

#IsDebugAfterCharge ⇒ Object

#IsDeleteResponseErrorCodes ⇒ Object

#MicroServices ⇒ Object

#OauthConfig ⇒ Object

#Protocol ⇒ Object

#RequestConfig ⇒ Object

#RequestParameters ⇒ Object

#ResponseErrorCodes ⇒ Object

#ResponseFailExample ⇒ Object

#ResponseSuccessExample ⇒ Object

#ResponseType ⇒ Object

#ServiceConfig ⇒ Object

#ServiceId ⇒ Object

#ServiceMockReturnMessage ⇒ Object

#ServiceParameters ⇒ Object

#ServiceScfEventIsAsyncCall ⇒ Object

#ServiceScfFunctionName ⇒ Object

#ServiceScfFunctionNamespace ⇒ Object

#ServiceScfFunctionQualifier ⇒ Object

#ServiceScfFunctionType ⇒ Object

#ServiceScfIsIntegratedResponse ⇒ Object

#ServiceTimeout ⇒ Object

#ServiceTsfHealthCheckConf ⇒ Object

#ServiceTsfLoadBalanceConf ⇒ Object

#ServiceType ⇒ Object

#ServiceWebsocketCleanupFunctionName ⇒ Object

#ServiceWebsocketCleanupFunctionNamespace ⇒ Object

#ServiceWebsocketCleanupFunctionQualifier ⇒ Object

#ServiceWebsocketRegisterFunctionName ⇒ Object

#ServiceWebsocketRegisterFunctionNamespace ⇒ Object

#ServiceWebsocketRegisterFunctionQualifier ⇒ Object

#ServiceWebsocketTransportFunctionName ⇒ Object

#ServiceWebsocketTransportFunctionNamespace ⇒ Object

#ServiceWebsocketTransportFunctionQualifier ⇒ Object

#TagSpecifications ⇒ Object

#TargetServicesHealthCheckConf ⇒ Object

#TargetServicesLoadBalanceConf ⇒ Object

#TokenTimeout ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#ApiBusinessType ⇒ `Object`

#ApiDesc ⇒ `Object`

#ApiId ⇒ `Object`

#ApiName ⇒ `Object`

#ApiType ⇒ `Object`

#AuthRelationApiId ⇒ `Object`

#AuthRequired ⇒ `Object`

#AuthType ⇒ `Object`

#Base64EncodedTriggerRules ⇒ `Object`

#ConstantParameters ⇒ `Object`

#EIAMAppId ⇒ `Object`

#EIAMAppType ⇒ `Object`

#EIAMAuthType ⇒ `Object`

#EnableCORS ⇒ `Object`

#EventBusId ⇒ `Object`

#IsBase64Encoded ⇒ `Object`

#IsBase64Trigger ⇒ `Object`

#IsDebugAfterCharge ⇒ `Object`

#IsDeleteResponseErrorCodes ⇒ `Object`

#MicroServices ⇒ `Object`

#OauthConfig ⇒ `Object`

#Protocol ⇒ `Object`

#RequestConfig ⇒ `Object`

#RequestParameters ⇒ `Object`

#ResponseErrorCodes ⇒ `Object`

#ResponseFailExample ⇒ `Object`

#ResponseSuccessExample ⇒ `Object`

#ResponseType ⇒ `Object`

#ServiceConfig ⇒ `Object`

#ServiceId ⇒ `Object`

#ServiceMockReturnMessage ⇒ `Object`

#ServiceParameters ⇒ `Object`

#ServiceScfEventIsAsyncCall ⇒ `Object`

#ServiceScfFunctionName ⇒ `Object`

#ServiceScfFunctionNamespace ⇒ `Object`

#ServiceScfFunctionQualifier ⇒ `Object`

#ServiceScfFunctionType ⇒ `Object`

#ServiceScfIsIntegratedResponse ⇒ `Object`

#ServiceTimeout ⇒ `Object`

#ServiceTsfHealthCheckConf ⇒ `Object`

#ServiceTsfLoadBalanceConf ⇒ `Object`

#ServiceType ⇒ `Object`

#ServiceWebsocketCleanupFunctionName ⇒ `Object`

#ServiceWebsocketCleanupFunctionNamespace ⇒ `Object`

#ServiceWebsocketCleanupFunctionQualifier ⇒ `Object`

#ServiceWebsocketRegisterFunctionName ⇒ `Object`

#ServiceWebsocketRegisterFunctionNamespace ⇒ `Object`

#ServiceWebsocketRegisterFunctionQualifier ⇒ `Object`

#ServiceWebsocketTransportFunctionName ⇒ `Object`

#ServiceWebsocketTransportFunctionNamespace ⇒ `Object`

#ServiceWebsocketTransportFunctionQualifier ⇒ `Object`

#TagSpecifications ⇒ `Object`

#TargetServicesHealthCheckConf ⇒ `Object`

#TargetServicesLoadBalanceConf ⇒ `Object`

#TokenTimeout ⇒ `Object`

#deserialize(params) ⇒ `Object`