v20180808

package
v1.0.926 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 21, 2024 License: Apache-2.0 Imports: 7 Imported by: 3

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
	DRYRUNOPERATION = "DryRunOperation"

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 自定义密钥已存在。
	FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"

	// 该api绑定了使用计划。
	FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"

	// Apis 绑定了使用计划,请先解绑再试。
	FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment"

	// api类错误。
	FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"

	// 当前API正在操作中,请稍后再试。
	FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"

	// 返回域名错误
	FAILEDOPERATION_BACKENDDOMAINERROR = "FailedOperation.BackendDomainError"

	// CAM异常
	FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"

	// 证书绑定错误。
	FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError"

	// 该证书为企业证书,待提交。
	FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit"

	// 证书不存在或者您没有权限查看,请在ssl证书管理平台上传有效证书。
	FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError"

	// 证书已过期,请上传其他有效证书。
	FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired"

	// 该证书信息内容为空,请联系证书同事。
	FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError"

	// 该证书处于审核中状态,请上传其他有效证书。
	FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify"

	// 证书处于未知状态,请联系证书同事查看具体状态。
	FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError"

	// 证书处于审核失败状态,请上传其他有效证书。
	FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail"

	// Apis 证书为空,请上传证书。
	FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull"

	// 调用CLS服务失败。
	FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"

	// API文档操作失败。
	FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"

	// Apis 环境配置错误。
	FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError"

	// Apis自定义路径映射不能为空。
	FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull"

	// Apis 参数重复。
	FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat"

	// Apis自定义路径配置错误。
	FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError"

	// 删除自定义域名错误。
	FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError"

	// 服务自定义域名错误。
	FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError"

	// 该域名已经绑定其他服务。
	FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService"

	// 该域名已经绑定该服务。
	FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService"

	// 当前域名不满足合规要求,无法进行接入。
	FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList"

	// 该域名还未在腾讯云备案,请备案之后再绑定域名。
	FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"

	// 自定义域名解绑失败,域名未绑定该服务。
	FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService"

	// 该域名未配置cname到默认域名,或者解析未生效。
	FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError"

	// EIAM返回错误。
	FAILEDOPERATION_EIAMERROR = "FailedOperation.EIAMError"

	// 事件总线绑定/解绑失败。
	FAILEDOPERATION_EBERROR = "FailedOperation.EbError"

	// 域名格式错误。
	FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"

	// 获取角色失败,请确认完成API网关相关服务接口授权。
	FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"

	// 实例不存在,或者无效状态。
	FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"

	// 无效的输入json
	FAILEDOPERATION_INVALIDINPUTJSON = "FailedOperation.InvalidInputJSON"

	// Apis 自定义路径与默认路径冲突。
	FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping"

	// 默认的二级域名输入错误。
	FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError"

	// 操作后端通道失败。
	FAILEDOPERATION_OPERATEUPSTREAM = "FailedOperation.OperateUpstream"

	// 设置路径映射错误。
	FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError"

	// SCF触发器绑定/解绑操作失败。
	FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError"

	// 服务相关的错误。
	FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"

	// 当前Service正在操作中, 请稍后再试。
	FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"

	// 服务不存在。
	FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"

	// 自定义域名已使用默认路径映射,不支持设置自定义路径。
	FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError"

	// 自定义域名格式错误。
	FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"

	// 标签绑定服务失败。
	FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"

	// 迁移任务重复
	FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"

	// 协议类型错误。
	FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// API网关内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"

	// CAM内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"

	// CAuth内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException"

	// CLB内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_CLBEXCEPTION = "InternalError.ClbException"

	// 数据库操作失败,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_DBEXCEPTION = "InternalError.DbException"

	// oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"

	// 标签回调失败。
	INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"

	// SCF内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"

	// TSF内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"

	// vpc内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
	INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 基础版服务不能绑定插件。
	INVALIDPARAMETER_BASICSERVICENOTALLOWATTACHPLUGIN = "InvalidParameter.BasicServiceNotAllowAttachPlugin"

	// 当前绑定插件和已有插件冲突。
	INVALIDPARAMETER_DUPLICATEPLUGINCONFIG = "InvalidParameter.DuplicatePluginConfig"

	// 参数格式错误。
	INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 插件定义参数取值重复,请修改后重新操作。
	INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"

	// 非法的后端ip地址。
	INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp"

	// 密钥错误。
	INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds"

	// 传入的Api业务类型必须为OAUTH。
	INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"

	// API Id错误。
	INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds"

	// 无效的API配置。
	INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"

	// API类型错误,微服务API只支持TSF后端服务类型。
	INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType"

	// 后端服务路径配置错误。
	INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"

	// 不合法的clb。
	INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"

	// 策略错误。
	INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition"

	// 不合法的常量参数。
	INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters"

	// 参数Env取值错误,取值范围为(release, prepub, test)。
	INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv"

	// 服务当前环境状态,不支持此操作。
	INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"

	// 参数取值错误。
	INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"

	// 参数后端地址取值错误。
	INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"

	// 参数请求配额总数取值错误。
	INVALIDPARAMETERVALUE_INVALIDMAXREQUESTNUM = "InvalidParameterValue.InvalidMaxRequestNum"

	// 方法错误。仅支持 ANY, BEGIN, GET, POST, DELETE, HEAD, PUT, OPTIONS, TRACE, PATCH,请修改后重新操作。
	INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod"

	// 插件定义参数取值错误,请修改后重新操作。
	INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig"

	// 后端服务端口错误。
	INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"

	// 无效的协议类型参数。
	INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol"

	// OAUTH2.0 API 公钥参数格式错误。
	INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey"

	// 地域错误。
	INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"

	// 不合法的请求参数。
	INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"

	// SCF类型API参数错误。
	INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"

	// 不合法的服务配置。
	INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"

	// 参数ServiceMockReturnMessage错误。
	INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage"

	// 参数配置错误,未配置在后端参数配置列表中。
	INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"

	// 参数ServiceParameters错误。
	INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters"

	// 后端服务类型错误。WEBSOCKET类型的后端服务,前端协议需要配置为WEBSOCKET。
	INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"

	// 标签参数错误。
	INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues"

	// TSF类型API配置错误。
	INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig"

	// 当前后端通道不存在或者是无效状态。
	INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"

	// URL参数错误。
	INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"

	// 无效vpc信息。
	INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"

	// 方法错误。WEBSOCKET类型的后端服务,前端方法需要配置为GET。
	INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod"

	// 参数的长度超出限制。
	INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"

	// 参数个数超出限制,上限为100。
	INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"

	// 参数取值错误。当前值不在可选范围内。
	INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"

	// OAuth接口无可用修改项。
	INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth"

	// 后端参数配置错误,未配置相关前端参数。
	INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch"

	// 参数个数超过限制。
	INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded"

	// 参数取值错误,不在参数范围内。
	INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"

	// 无效的参数值
	INVALIDPARAMETERVALUE_TRAFFICCONTROL = "InvalidParameterValue.TrafficControl"

	// 参数取值错误。
	INVALIDPARAMETERVALUE_UNSUPPORTEDPARAMETER = "InvalidParameterValue.UnsupportedParameter"

	// 超过配额限制。
	LIMITEXCEEDED = "LimitExceeded"

	// API文档数量超出限制。
	LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded"

	// 访问密钥数量超出限制。
	LIMITEXCEEDED_ACCESSKEYCOUNTINUSAGEPLANLIMITEXCEEDED = "LimitExceeded.AccessKeyCountInUsagePlanLimitExceeded"

	// 服务绑定的应用数量超过限制。
	LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded"

	// API数量超过限制。
	LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"

	// 密钥数量超出限制。
	LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"

	// 自定义路径映射,最多三组。
	LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit"

	// 绑定域名数量超出限制,默认最多5个。
	LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit"

	// IP策略数量超出限制。
	LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded"

	// 请求频率超限制,请稍等再试。
	LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"

	// 插件绑定的服务数量超出限制,请解绑服务或提升限额后重试。
	LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded"

	// 服务数量超过限制,请删除服务或提升限额后重试。
	LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded"

	// 使用计划数量超出限制。
	LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 缺少后端服务参数。
	MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"

	// 插件缺少参数,请按规则重新操作。
	MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig"

	// 操作被拒绝。
	OPERATIONDENIED = "OperationDenied"

	// 请求的次数超过了频率限制。
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// 资源被占用。
	RESOURCEINUSE = "ResourceInUse"

	// 资源不足。
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 密钥不存在。
	RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"

	// ApiId错误。
	RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"

	// 应用ID错误。
	RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"

	// API文档不存在。
	RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"

	// IP策略不存在。
	RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

	// OAuth业务API错误。
	RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi"

	// 插件不存在。
	RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"

	// 对应服务不可见。
	RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

	// 使用计划不存在。
	RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// 资源售罄。
	RESOURCESSOLDOUT = "ResourcesSoldOut"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// 您没有权限访问资源。
	UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

	// 用户未实名制。
	UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// 账号余额不足
	UNSUPPORTEDOPERATION_ACCOUNTARREARS = "UnsupportedOperation.AccountArrears"

	// 密钥已绑定使用计划。
	UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan"

	// API列表不为空
	UNSUPPORTEDOPERATION_APILISTNOTEMPTY = "UnsupportedOperation.ApiListNotEmpty"

	// 当前插件不支持绑定。
	UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin"

	// 基础版服务不能创建超过一个API。
	UNSUPPORTEDOPERATION_BASICSERVICENOMOREAPI = "UnsupportedOperation.BasicServiceNoMoreApi"

	// 基础服务不允许连接插件
	UNSUPPORTEDOPERATION_BASICSERVICENOTALLOWATTACHPLUGIN = "UnsupportedOperation.BasicServiceNotAllowAttachPlugin"

	// 日志检索起始时间间隔。
	UNSUPPORTEDOPERATION_CLSSEARCHTIME = "UnsupportedOperation.ClsSearchTime"

	// 存在现网环境
	UNSUPPORTEDOPERATION_EXISTINGONLINEENVIRONMENT = "UnsupportedOperation.ExistingOnlineEnvironment"

	// 协议为HTTP时,不支持强制Https。
	UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps"

	// 接口错误。
	UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

	// 不支持后端类型。
	UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"

	// 当前实例状态,不支持当前操作。
	UNSUPPORTEDOPERATION_INVALIDINSTANCESTATE = "UnsupportedOperation.InvalidInstanceState"

	// 当前服务处于隔离中,暂不支持此操作。
	UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

	// 当前密钥状态不支持此操作。
	UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"

	// 不支持修改EIAM类型授权API。
	UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi"

	// 网络类型不支持修改。
	UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType"

	// 前端协议类型不支持修改。
	UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol"

	// 当前使用计划未绑定环境。
	UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv"

	// 不支持减少网络类型的操作。
	UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes"

	// 请求Post失败
	UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

	// 资源已关联,请先解除。
	UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"

	// 密钥已绑定使用计划,请先解绑再试。
	UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse"

	// 资源未关联。
	UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated"

	// 服务不存在
	UNSUPPORTEDOPERATION_SERVICEEXIST = "UnsupportedOperation.ServiceExist"

	// 标签不为空
	UNSUPPORTEDOPERATION_TAGSNOTEMPTY = "UnsupportedOperation.TagsNotEmpty"

	// 当前Uin未在手工密钥白名单列表内。
	UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"

	// Unpack函数错误
	UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

	// 密钥已绑定使用计划。
	UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey"

	// 不支持绑定环境。
	UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"

	// 当前API已绑定业务API,请先解绑再试。
	UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

	// 服务使用中,不能被删除。
	UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService"

	// 当前VPC通道存在绑定关系,不支持当前操作。
	UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEUPSTREAM = "UnsupportedOperation.UnsupportedDeleteUpstream"

	// 不支持网络类型。
	UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType"

	// 不支持解绑环境,存在未绑定使用计划的API。
	UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"

	// 当前密钥状态不支持此操作。
	UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"

	// 当前使用计划在使用中,请先解绑再试。
	UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"
)
View Source
const APIVersion = "2018-08-08"

Variables

This section is empty.

Functions

This section is empty.

Types

type APIDoc

type APIDoc struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`

	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// API文档构建状态
	ApiDocStatus *string `json:"ApiDocStatus,omitnil,omitempty" name:"ApiDocStatus"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type APIDocInfo

type APIDocInfo struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`

	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// API文档构建状态
	ApiDocStatus *string `json:"ApiDocStatus,omitnil,omitempty" name:"ApiDocStatus"`

	// API文档API数量
	ApiCount *int64 `json:"ApiCount,omitnil,omitempty" name:"ApiCount"`

	// API文档查看次数
	ViewCount *int64 `json:"ViewCount,omitnil,omitempty" name:"ViewCount"`

	// API文档发布次数
	ReleaseCount *int64 `json:"ReleaseCount,omitnil,omitempty" name:"ReleaseCount"`

	// API文档访问URI
	ApiDocUri *string `json:"ApiDocUri,omitnil,omitempty" name:"ApiDocUri"`

	// API文档分享密码
	SharePassword *string `json:"SharePassword,omitnil,omitempty" name:"SharePassword"`

	// API文档更新时间
	UpdatedTime *string `json:"UpdatedTime,omitnil,omitempty" name:"UpdatedTime"`

	// 服务ID
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境信息
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 生成API文档的API ID
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// 服务名称
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 生成API文档的API名称
	ApiNames []*string `json:"ApiNames,omitnil,omitempty" name:"ApiNames"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type APIDocs

type APIDocs struct {
	// API文档数量
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// API文档基本信息
	APIDocSet []*APIDoc `json:"APIDocSet,omitnil,omitempty" name:"APIDocSet"`
}

type ApiAppApiInfo added in v1.0.209

type ApiAppApiInfo struct {
	// 应用名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 应用ID
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// Api的ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// Api名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 服务ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 授权绑定时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthorizedTime *string `json:"AuthorizedTime,omitnil,omitempty" name:"AuthorizedTime"`

	// Api所属地域
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiRegion *string `json:"ApiRegion,omitnil,omitempty" name:"ApiRegion"`

	// 授权绑定的环境
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`
}

type ApiAppApiInfos added in v1.0.209

type ApiAppApiInfos struct {
	// 数量
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 应用绑定的Api信息数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppApiSet []*ApiAppApiInfo `json:"ApiAppApiSet,omitnil,omitempty" name:"ApiAppApiSet"`
}

type ApiAppInfo added in v1.0.209

type ApiAppInfo struct {
	// 应用名称
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 应用ID
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 应用SECRET
	// 注意:此字段可能返回null,表示取不到有效值
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppSecret *string `json:"ApiAppSecret,omitnil,omitempty" name:"ApiAppSecret"`

	// 应用描述
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppDesc *string `json:"ApiAppDesc,omitnil,omitempty" name:"ApiAppDesc"`

	// 创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 修改时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 应用KEY
	// 注意:此字段可能返回null,表示取不到有效值
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppKey *string `json:"ApiAppKey,omitnil,omitempty" name:"ApiAppKey"`
}

type ApiAppInfos added in v1.0.209

type ApiAppInfos struct {
	// 应用数量
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 应用信息数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiAppSet []*ApiAppInfo `json:"ApiAppSet,omitnil,omitempty" name:"ApiAppSet"`
}

type ApiEnvironmentStrategy

type ApiEnvironmentStrategy struct {
	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义API名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API的路径。如/path。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API的方法。如GET。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 环境的限流信息。
	EnvironmentStrategySet []*EnvironmentStrategy `json:"EnvironmentStrategySet,omitnil,omitempty" name:"EnvironmentStrategySet"`
}

type ApiEnvironmentStrategyStatus added in v1.0.701

type ApiEnvironmentStrategyStatus struct {
	// API绑定的限流策略数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// API绑定的限流策略列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiEnvironmentStrategySet []*ApiEnvironmentStrategy `json:"ApiEnvironmentStrategySet,omitnil,omitempty" name:"ApiEnvironmentStrategySet"`
}

type ApiIdStatus

type ApiIdStatus struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API描述
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// API PATH。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API METHOD。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 服务创建时间。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 服务修改时间。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// API名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// VPC唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// API类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API协议。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 是否买后调试。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 授权类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// API业务类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// 关联授权API唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// 授权API关联的业务API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	//
	// Deprecated: RelationBuniessApiIds is deprecated.
	RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitnil,omitempty" name:"RelationBuniessApiIds"`

	// oauth配置信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// oauth2.0API请求,token存放位置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TokenLocation *string `json:"TokenLocation,omitnil,omitempty" name:"TokenLocation"`
}

type ApiInfo

type ApiInfo struct {
	// API 所在的服务唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 所在的服务的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// API 所在的服务的描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// API 接口唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API 接口的描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// 创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// API 接口的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API 类型。可取值为NORMAL(普通API)、TSF(微服务API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// API 鉴权类型。可取值为 SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// OAUTH API的类型。可取值为NORMAL(业务API)、�OAUTH(授权API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// OAUTH 业务API 关联的授权API 唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// OAUTH配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 是否购买后调试(云市场预留参数)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 请求的前端配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RequestConfig *RequestConfig `json:"RequestConfig,omitnil,omitempty" name:"RequestConfig"`

	// 返回类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// 自定义响应配置成功响应示例。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResponseSuccessExample *string `json:"ResponseSuccessExample,omitnil,omitempty" name:"ResponseSuccessExample"`

	// 自定义响应配置失败响应示例。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResponseFailExample *string `json:"ResponseFailExample,omitnil,omitempty" name:"ResponseFailExample"`

	// 用户自定义错误码配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResponseErrorCodes []*ErrorCodes `json:"ResponseErrorCodes,omitnil,omitempty" name:"ResponseErrorCodes"`

	// 前端请求参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RequestParameters []*ReqParameter `json:"RequestParameters,omitnil,omitempty" name:"RequestParameters"`

	// API 的后端服务超时时间,单位是秒。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceTimeout *int64 `json:"ServiceTimeout,omitnil,omitempty" name:"ServiceTimeout"`

	// API 的后端服务类型。可取值为 HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// API 的后端服务配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceConfig *ServiceConfig `json:"ServiceConfig,omitnil,omitempty" name:"ServiceConfig"`

	// API的后端服务参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceParameters []*DescribeApiResultServiceParametersInfo `json:"ServiceParameters,omitnil,omitempty" name:"ServiceParameters"`

	// 常量参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitnil,omitempty" name:"ConstantParameters"`

	// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitnil,omitempty" name:"ServiceMockReturnMessage"`

	// scf 函数名称。当后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitnil,omitempty" name:"ServiceScfFunctionName"`

	// scf 函数命名空间。当后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitnil,omitempty" name:"ServiceScfFunctionNamespace"`

	// scf函数版本。当后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitnil,omitempty" name:"ServiceScfFunctionQualifier"`

	// 是否开启集成响应。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitnil,omitempty" name:"ServiceScfIsIntegratedResponse"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionName"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`

	// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionName"`

	// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`

	// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`

	// WEBSOCKET 回推地址。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InternalDomain *string `json:"InternalDomain,omitnil,omitempty" name:"InternalDomain"`

	// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionName"`

	// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`

	// API绑定微服务列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MicroServices []*MicroService `json:"MicroServices,omitnil,omitempty" name:"MicroServices"`

	// 微服务信息详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MicroServicesInfo []*int64 `json:"MicroServicesInfo,omitnil,omitempty" name:"MicroServicesInfo"`

	// 微服务的负载均衡配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitnil,omitempty" name:"ServiceTsfLoadBalanceConf"`

	// 微服务的健康检查配置。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitnil,omitempty" name:"ServiceTsfHealthCheckConf"`

	// 是否开启跨域。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnableCORS *bool `json:"EnableCORS,omitnil,omitempty" name:"EnableCORS"`

	// API绑定的tag信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// API已发布的环境信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Environments []*string `json:"Environments,omitnil,omitempty" name:"Environments"`

	// 是否开启Base64编码,只有后端为scf时才会生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsBase64Encoded *bool `json:"IsBase64Encoded,omitnil,omitempty" name:"IsBase64Encoded"`

	// 是否开启Base64编码的header触发,只有后端为scf时才会生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsBase64Trigger *bool `json:"IsBase64Trigger,omitnil,omitempty" name:"IsBase64Trigger"`

	// Header触发规则,总规则数量不超过10。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitnil,omitempty" name:"Base64EncodedTriggerRules"`

	// 是否开启SCF Event异步调用。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceScfEventIsAsyncCall *bool `json:"ServiceScfEventIsAsyncCall,omitnil,omitempty" name:"ServiceScfEventIsAsyncCall"`
}

type ApiInfoSummary added in v1.0.204

type ApiInfoSummary struct {
	// 插件相关的API总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 插件相关的API信息。
	ApiSet []*AvailableApiInfo `json:"ApiSet,omitnil,omitempty" name:"ApiSet"`
}

type ApiKey

type ApiKey struct {
	// 创建的 API 密钥 ID 。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 创建的 API 密钥 Key。
	AccessKeySecret *string `json:"AccessKeySecret,omitnil,omitempty" name:"AccessKeySecret"`

	// 密钥类型,auto 或者 manual。
	AccessKeyType *string `json:"AccessKeyType,omitnil,omitempty" name:"AccessKeyType"`

	// 用户自定义密钥名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 最后一次修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 密钥状态。0表示禁用,1表示启用。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type ApiKeysStatus

type ApiKeysStatus struct {
	// 符合条件的 API 密钥数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// API 密钥列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiKeySet []*ApiKey `json:"ApiKeySet,omitnil,omitempty" name:"ApiKeySet"`
}

type ApiRequestConfig

type ApiRequestConfig struct {
	// path
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// 方法
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`
}

type ApiUsagePlan

type ApiUsagePlan struct {
	// 服务唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API 名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API 路径。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 方法。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 使用计划的唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 使用计划的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 使用计划的描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 使用计划绑定的服务环境。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 已经使用的配额。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InUseRequestNum *int64 `json:"InUseRequestNum,omitnil,omitempty" name:"InUseRequestNum"`

	// 请求配额总量,-1表示没有限制。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 请求 QPS 上限,-1 表示没有限制。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 使用计划创建时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 使用计划最后修改时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 服务名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type ApiUsagePlanSet

type ApiUsagePlanSet struct {
	// API 绑定的使用计划总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// API 绑定使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiUsagePlanList []*ApiUsagePlan `json:"ApiUsagePlanList,omitnil,omitempty" name:"ApiUsagePlanList"`
}

type ApigatewayTags added in v1.0.675

type ApigatewayTags struct {
}

type AttachPluginRequest added in v1.0.204

type AttachPluginRequest struct {
	*tchttp.BaseRequest

	// 绑定的API网关插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要操作的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要操作API的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 要绑定的API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewAttachPluginRequest added in v1.0.204

func NewAttachPluginRequest() (request *AttachPluginRequest)

func (*AttachPluginRequest) FromJsonString added in v1.0.204

func (r *AttachPluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AttachPluginRequest) ToJsonString added in v1.0.204

func (r *AttachPluginRequest) ToJsonString() string

type AttachPluginRequestParams added in v1.0.426

type AttachPluginRequestParams struct {
	// 绑定的API网关插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要操作的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要操作API的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 要绑定的API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type AttachPluginResponse added in v1.0.204

type AttachPluginResponse struct {
	*tchttp.BaseResponse
	Response *AttachPluginResponseParams `json:"Response"`
}

func NewAttachPluginResponse added in v1.0.204

func NewAttachPluginResponse() (response *AttachPluginResponse)

func (*AttachPluginResponse) FromJsonString added in v1.0.204

func (r *AttachPluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AttachPluginResponse) ToJsonString added in v1.0.204

func (r *AttachPluginResponse) ToJsonString() string

type AttachPluginResponseParams added in v1.0.426

type AttachPluginResponseParams struct {
	// 绑定操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AttachedApiInfo

type AttachedApiInfo struct {
	// API所在服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API所在服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// API所在服务描述信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// 插件绑定API的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 插件和API绑定时间。
	AttachedTime *string `json:"AttachedTime,omitnil,omitempty" name:"AttachedTime"`
}

type AttachedApiSummary added in v1.0.204

type AttachedApiSummary struct {
	// 插件绑定的API数量。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 插件绑定的API信息。
	AttachedApis []*AttachedApiInfo `json:"AttachedApis,omitnil,omitempty" name:"AttachedApis"`
}

type AttachedPluginInfo added in v1.0.533

type AttachedPluginInfo struct {
	// 插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 环境信息。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 绑定时间。
	AttachedTime *string `json:"AttachedTime,omitnil,omitempty" name:"AttachedTime"`

	// 插件名称。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 插件类型。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 插件描述。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 插件定义语句。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`
}

type AttachedPluginSummary added in v1.0.533

type AttachedPluginSummary struct {
	// 已绑定的插件总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 已绑定的插件信息。
	PluginSummary []*AttachedPluginInfo `json:"PluginSummary,omitnil,omitempty" name:"PluginSummary"`
}

type AvailableApiInfo added in v1.0.204

type AvailableApiInfo struct {
	// API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API类型。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API路径。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API方法。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// API是否绑定其他插件。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AttachedOtherPlugin *bool `json:"AttachedOtherPlugin,omitnil,omitempty" name:"AttachedOtherPlugin"`

	// API是否绑定当前插件。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsAttached *bool `json:"IsAttached,omitnil,omitempty" name:"IsAttached"`
}

type Base64EncodedTriggerRule

type Base64EncodedTriggerRule struct {
	// 进行编码触发的header,可选值 "Accept"和"Content_Type" 对应实际数据流请求header中的Accept和 Content-Type。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 进行编码触发的header的可选值数组, 数组元素的字符串最大长度为40,元素可以包括数字,英文字母以及特殊字符,特殊字符的可选值为: `.`    `+`    `*`   `-`   `/`  `_`
	//
	// 例如 [
	//     "application/x-vpeg005",
	//     "application/xhtml+xml",
	//     "application/vnd.ms-project",
	//     "application/vnd.rn-rn_music_package"
	// ] 等都是合法的。
	Value []*string `json:"Value,omitnil,omitempty" name:"Value"`
}

type BindApiAppRequest added in v1.0.209

type BindApiAppRequest struct {
	*tchttp.BaseRequest

	// 待绑定的应用唯一 ID 。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

func NewBindApiAppRequest added in v1.0.209

func NewBindApiAppRequest() (request *BindApiAppRequest)

func (*BindApiAppRequest) FromJsonString added in v1.0.209

func (r *BindApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindApiAppRequest) ToJsonString added in v1.0.209

func (r *BindApiAppRequest) ToJsonString() string

type BindApiAppRequestParams added in v1.0.426

type BindApiAppRequestParams struct {
	// 待绑定的应用唯一 ID 。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

Predefined struct for user

type BindApiAppResponse added in v1.0.209

type BindApiAppResponse struct {
	*tchttp.BaseResponse
	Response *BindApiAppResponseParams `json:"Response"`
}

func NewBindApiAppResponse added in v1.0.209

func NewBindApiAppResponse() (response *BindApiAppResponse)

func (*BindApiAppResponse) FromJsonString added in v1.0.209

func (r *BindApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindApiAppResponse) ToJsonString added in v1.0.209

func (r *BindApiAppResponse) ToJsonString() string

type BindApiAppResponseParams added in v1.0.426

type BindApiAppResponseParams struct {
	// 绑定操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindApiInfo added in v1.0.357

type BindApiInfo struct {
	// api唯一id
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// Service唯一id
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// api名字
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 服务名字
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 绑定时间
	BindTime *string `json:"BindTime,omitnil,omitempty" name:"BindTime"`
}

type BindEnvironmentRequest

type BindEnvironmentRequest struct {
	*tchttp.BaseRequest

	// 待绑定的使用计划唯一 ID 列表。
	UsagePlanIds []*string `json:"UsagePlanIds,omitnil,omitempty" name:"UsagePlanIds"`

	// 绑定类型,取值为API、SERVICE,默认值为SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API唯一ID数组,当bindType=API时,需要传入此参数。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewBindEnvironmentRequest

func NewBindEnvironmentRequest() (request *BindEnvironmentRequest)

func (*BindEnvironmentRequest) FromJsonString

func (r *BindEnvironmentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindEnvironmentRequest) ToJsonString

func (r *BindEnvironmentRequest) ToJsonString() string

type BindEnvironmentRequestParams added in v1.0.426

type BindEnvironmentRequestParams struct {
	// 待绑定的使用计划唯一 ID 列表。
	UsagePlanIds []*string `json:"UsagePlanIds,omitnil,omitempty" name:"UsagePlanIds"`

	// 绑定类型,取值为API、SERVICE,默认值为SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API唯一ID数组,当bindType=API时,需要传入此参数。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type BindEnvironmentResponse

type BindEnvironmentResponse struct {
	*tchttp.BaseResponse
	Response *BindEnvironmentResponseParams `json:"Response"`
}

func NewBindEnvironmentResponse

func NewBindEnvironmentResponse() (response *BindEnvironmentResponse)

func (*BindEnvironmentResponse) FromJsonString

func (r *BindEnvironmentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindEnvironmentResponse) ToJsonString

func (r *BindEnvironmentResponse) ToJsonString() string

type BindEnvironmentResponseParams added in v1.0.426

type BindEnvironmentResponseParams struct {
	// 绑定操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindIPStrategyRequest

type BindIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 待绑定的IP策略所属的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// IP策略待绑定的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// IP策略待绑定的API列表。
	BindApiIds []*string `json:"BindApiIds,omitnil,omitempty" name:"BindApiIds"`
}

func NewBindIPStrategyRequest

func NewBindIPStrategyRequest() (request *BindIPStrategyRequest)

func (*BindIPStrategyRequest) FromJsonString

func (r *BindIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindIPStrategyRequest) ToJsonString

func (r *BindIPStrategyRequest) ToJsonString() string

type BindIPStrategyRequestParams added in v1.0.426

type BindIPStrategyRequestParams struct {
	// 待绑定的IP策略所属的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// IP策略待绑定的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// IP策略待绑定的API列表。
	BindApiIds []*string `json:"BindApiIds,omitnil,omitempty" name:"BindApiIds"`
}

Predefined struct for user

type BindIPStrategyResponse

type BindIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *BindIPStrategyResponseParams `json:"Response"`
}

func NewBindIPStrategyResponse

func NewBindIPStrategyResponse() (response *BindIPStrategyResponse)

func (*BindIPStrategyResponse) FromJsonString

func (r *BindIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindIPStrategyResponse) ToJsonString

func (r *BindIPStrategyResponse) ToJsonString() string

type BindIPStrategyResponseParams added in v1.0.426

type BindIPStrategyResponseParams struct {
	// 绑定操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindSecretIdsRequest

type BindSecretIdsRequest struct {
	*tchttp.BaseRequest

	// 待绑定的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待绑定的密钥 ID 数组。
	AccessKeyIds []*string `json:"AccessKeyIds,omitnil,omitempty" name:"AccessKeyIds"`
}

func NewBindSecretIdsRequest

func NewBindSecretIdsRequest() (request *BindSecretIdsRequest)

func (*BindSecretIdsRequest) FromJsonString

func (r *BindSecretIdsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindSecretIdsRequest) ToJsonString

func (r *BindSecretIdsRequest) ToJsonString() string

type BindSecretIdsRequestParams added in v1.0.426

type BindSecretIdsRequestParams struct {
	// 待绑定的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待绑定的密钥 ID 数组。
	AccessKeyIds []*string `json:"AccessKeyIds,omitnil,omitempty" name:"AccessKeyIds"`
}

Predefined struct for user

type BindSecretIdsResponse

type BindSecretIdsResponse struct {
	*tchttp.BaseResponse
	Response *BindSecretIdsResponseParams `json:"Response"`
}

func NewBindSecretIdsResponse

func NewBindSecretIdsResponse() (response *BindSecretIdsResponse)

func (*BindSecretIdsResponse) FromJsonString

func (r *BindSecretIdsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindSecretIdsResponse) ToJsonString

func (r *BindSecretIdsResponse) ToJsonString() string

type BindSecretIdsResponseParams added in v1.0.426

type BindSecretIdsResponseParams struct {
	// 绑定操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindSubDomainRequest

type BindSubDomainRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 服务支持协议,可选值为http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 网络类型,可选值为OUTER、INNER。
	NetType *string `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 默认域名。
	NetSubDomain *string `json:"NetSubDomain,omitnil,omitempty" name:"NetSubDomain"`

	// 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。
	CertificateId *string `json:"CertificateId,omitnil,omitempty" name:"CertificateId"`

	// 自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。
	PathMappingSet []*PathMapping `json:"PathMappingSet,omitnil,omitempty" name:"PathMappingSet"`

	// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
	IsForcedHttps *bool `json:"IsForcedHttps,omitnil,omitempty" name:"IsForcedHttps"`
}

func NewBindSubDomainRequest

func NewBindSubDomainRequest() (request *BindSubDomainRequest)

func (*BindSubDomainRequest) FromJsonString

func (r *BindSubDomainRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindSubDomainRequest) ToJsonString

func (r *BindSubDomainRequest) ToJsonString() string

type BindSubDomainRequestParams added in v1.0.426

type BindSubDomainRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 服务支持协议,可选值为http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 网络类型,可选值为OUTER、INNER。
	NetType *string `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 默认域名。
	NetSubDomain *string `json:"NetSubDomain,omitnil,omitempty" name:"NetSubDomain"`

	// 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。
	CertificateId *string `json:"CertificateId,omitnil,omitempty" name:"CertificateId"`

	// 自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。
	PathMappingSet []*PathMapping `json:"PathMappingSet,omitnil,omitempty" name:"PathMappingSet"`

	// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
	IsForcedHttps *bool `json:"IsForcedHttps,omitnil,omitempty" name:"IsForcedHttps"`
}

Predefined struct for user

type BindSubDomainResponse

type BindSubDomainResponse struct {
	*tchttp.BaseResponse
	Response *BindSubDomainResponseParams `json:"Response"`
}

func NewBindSubDomainResponse

func NewBindSubDomainResponse() (response *BindSubDomainResponse)

func (*BindSubDomainResponse) FromJsonString

func (r *BindSubDomainResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindSubDomainResponse) ToJsonString

func (r *BindSubDomainResponse) ToJsonString() string

type BindSubDomainResponseParams added in v1.0.426

type BindSubDomainResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BuildAPIDocRequest

type BuildAPIDocRequest struct {
	*tchttp.BaseRequest

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

func NewBuildAPIDocRequest

func NewBuildAPIDocRequest() (request *BuildAPIDocRequest)

func (*BuildAPIDocRequest) FromJsonString

func (r *BuildAPIDocRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BuildAPIDocRequest) ToJsonString

func (r *BuildAPIDocRequest) ToJsonString() string

type BuildAPIDocRequestParams added in v1.0.426

type BuildAPIDocRequestParams struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

Predefined struct for user

type BuildAPIDocResponse

type BuildAPIDocResponse struct {
	*tchttp.BaseResponse
	Response *BuildAPIDocResponseParams `json:"Response"`
}

func NewBuildAPIDocResponse

func NewBuildAPIDocResponse() (response *BuildAPIDocResponse)

func (*BuildAPIDocResponse) FromJsonString

func (r *BuildAPIDocResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BuildAPIDocResponse) ToJsonString

func (r *BuildAPIDocResponse) ToJsonString() string

type BuildAPIDocResponseParams added in v1.0.426

type BuildAPIDocResponseParams struct {
	// 操作是否成功
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) AttachPlugin added in v1.0.204

func (c *Client) AttachPlugin(request *AttachPluginRequest) (response *AttachPluginResponse, err error)

AttachPlugin 绑定插件到API上。

可能返回的错误码:

FAILEDOPERATION_INVALIDINPUTJSON = "FailedOperation.InvalidInputJSON"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_DUPLICATEPLUGINCONFIG = "InvalidParameter.DuplicatePluginConfig"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_TRAFFICCONTROL = "InvalidParameterValue.TrafficControl"
LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin"
UNSUPPORTEDOPERATION_BASICSERVICENOTALLOWATTACHPLUGIN = "UnsupportedOperation.BasicServiceNotAllowAttachPlugin"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) AttachPluginWithContext added in v1.0.324

func (c *Client) AttachPluginWithContext(ctx context.Context, request *AttachPluginRequest) (response *AttachPluginResponse, err error)

AttachPlugin 绑定插件到API上。

可能返回的错误码:

FAILEDOPERATION_INVALIDINPUTJSON = "FailedOperation.InvalidInputJSON"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_DUPLICATEPLUGINCONFIG = "InvalidParameter.DuplicatePluginConfig"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_TRAFFICCONTROL = "InvalidParameterValue.TrafficControl"
LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin"
UNSUPPORTEDOPERATION_BASICSERVICENOTALLOWATTACHPLUGIN = "UnsupportedOperation.BasicServiceNotAllowAttachPlugin"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) BindApiApp added in v1.0.209

func (c *Client) BindApiApp(request *BindApiAppRequest) (response *BindApiAppResponse, err error)

BindApiApp 本接口(BindApiApp)用于绑定应用到API。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv"
LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"

func (*Client) BindApiAppWithContext added in v1.0.324

func (c *Client) BindApiAppWithContext(ctx context.Context, request *BindApiAppRequest) (response *BindApiAppResponse, err error)

BindApiApp 本接口(BindApiApp)用于绑定应用到API。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv"
LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"

func (*Client) BindEnvironment

func (c *Client) BindEnvironment(request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)

BindEnvironment 本接口(BindEnvironment)用于绑定使用计划到服务或API。

用户在发布服务到某个环境中后,如果 API 需要鉴权,还需要绑定使用计划才能进行调用,此接口用户将使用计划绑定到特定环境。

目前支持绑定使用计划到API,但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划,所以对已经绑定过服务级别使用计划的环境,请先使用 服务级别使用计划降级 接口进行降级操作。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"

func (*Client) BindEnvironmentWithContext added in v1.0.324

func (c *Client) BindEnvironmentWithContext(ctx context.Context, request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)

BindEnvironment 本接口(BindEnvironment)用于绑定使用计划到服务或API。

用户在发布服务到某个环境中后,如果 API 需要鉴权,还需要绑定使用计划才能进行调用,此接口用户将使用计划绑定到特定环境。

目前支持绑定使用计划到API,但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划,所以对已经绑定过服务级别使用计划的环境,请先使用 服务级别使用计划降级 接口进行降级操作。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"

func (*Client) BindIPStrategy

func (c *Client) BindIPStrategy(request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)

BindIPStrategy 本接口(BindIPStrategy)用于API绑定IP策略。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) BindIPStrategyWithContext added in v1.0.324

func (c *Client) BindIPStrategyWithContext(ctx context.Context, request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)

BindIPStrategy 本接口(BindIPStrategy)用于API绑定IP策略。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) BindSecretIds

func (c *Client) BindSecretIds(request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)

BindSecretIds 本接口(BindSecretIds)用于为使用计划绑定密钥。

将密钥绑定到某个使用计划,并将此使用计划绑定到某个服务发布的环境上,调用者方可使用此密钥调用这个服务中的 API,可使用本接口为使用计划绑定密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_ACCESSKEYCOUNTINUSAGEPLANLIMITEXCEEDED = "LimitExceeded.AccessKeyCountInUsagePlanLimitExceeded"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey"

func (*Client) BindSecretIdsWithContext added in v1.0.324

func (c *Client) BindSecretIdsWithContext(ctx context.Context, request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)

BindSecretIds 本接口(BindSecretIds)用于为使用计划绑定密钥。

将密钥绑定到某个使用计划,并将此使用计划绑定到某个服务发布的环境上,调用者方可使用此密钥调用这个服务中的 API,可使用本接口为使用计划绑定密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_ACCESSKEYCOUNTINUSAGEPLANLIMITEXCEEDED = "LimitExceeded.AccessKeyCountInUsagePlanLimitExceeded"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey"

func (*Client) BindSubDomain

func (c *Client) BindSubDomain(request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)

BindSubDomain 本接口(BindSubDomain)用于绑定自定义域名到服务。

API 网关中每个服务都会提供一个默认的域名供用户调用,但当用户想使用自己的已有域名时,也可以将自定义域名绑定到此服务,在做好备案、与默认域名的 CNAME 后,可直接调用自定义域名。

可能返回的错误码:

FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit"
FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError"
FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired"
FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError"
FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify"
FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError"
FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail"
FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull"
FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError"
FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull"
FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat"
FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError"
FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService"
FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService"
FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError"
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping"
FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
INTERNALERROR = "InternalError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol"
LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit"
LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) BindSubDomainWithContext added in v1.0.324

func (c *Client) BindSubDomainWithContext(ctx context.Context, request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)

BindSubDomain 本接口(BindSubDomain)用于绑定自定义域名到服务。

API 网关中每个服务都会提供一个默认的域名供用户调用,但当用户想使用自己的已有域名时,也可以将自定义域名绑定到此服务,在做好备案、与默认域名的 CNAME 后,可直接调用自定义域名。

可能返回的错误码:

FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit"
FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError"
FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired"
FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError"
FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify"
FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError"
FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail"
FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull"
FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError"
FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull"
FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat"
FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError"
FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService"
FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService"
FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError"
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping"
FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
INTERNALERROR = "InternalError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol"
LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit"
LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) BuildAPIDoc

func (c *Client) BuildAPIDoc(request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)

BuildAPIDoc 构建 API 文档

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) BuildAPIDocWithContext added in v1.0.324

func (c *Client) BuildAPIDocWithContext(ctx context.Context, request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)

BuildAPIDoc 构建 API 文档

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) CreateAPIDoc

func (c *Client) CreateAPIDoc(request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)

CreateAPIDoc 创建 API 文档

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment"
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateAPIDocWithContext added in v1.0.324

func (c *Client) CreateAPIDocWithContext(ctx context.Context, request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)

CreateAPIDoc 创建 API 文档

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment"
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateApi

func (c *Client) CreateApi(request *CreateApiRequest) (response *CreateApiResponse, err error)

CreateApi 本接口(CreateApi)用于创建 API 接口,创建 API 前,用户需要先创建服务,每个 API 都有自己归属的服务。

可能返回的错误码:

FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_BACKENDDOMAINERROR = "FailedOperation.BackendDomainError"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_EIAMERROR = "FailedOperation.EIAMError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException"
INTERNALERROR_CLBEXCEPTION = "InternalError.ClbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_BASICSERVICENOMOREAPI = "UnsupportedOperation.BasicServiceNoMoreApi"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_SERVICEEXIST = "UnsupportedOperation.ServiceExist"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"
UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType"

func (*Client) CreateApiApp added in v1.0.209

func (c *Client) CreateApiApp(request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)

CreateApiApp 本接口(CreateApiApp)用于创建应用。

可能返回的错误码:

FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded"
LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateApiAppWithContext added in v1.0.324

func (c *Client) CreateApiAppWithContext(ctx context.Context, request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)

CreateApiApp 本接口(CreateApiApp)用于创建应用。

可能返回的错误码:

FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded"
LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateApiKey

func (c *Client) CreateApiKey(request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)

CreateApiKey 本接口(CreateApiKey)用于创建一对新的 API 密钥。

可能返回的错误码:

FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateApiKeyWithContext added in v1.0.324

func (c *Client) CreateApiKeyWithContext(ctx context.Context, request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)

CreateApiKey 本接口(CreateApiKey)用于创建一对新的 API 密钥。

可能返回的错误码:

FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateApiWithContext added in v1.0.324

func (c *Client) CreateApiWithContext(ctx context.Context, request *CreateApiRequest) (response *CreateApiResponse, err error)

CreateApi 本接口(CreateApi)用于创建 API 接口,创建 API 前,用户需要先创建服务,每个 API 都有自己归属的服务。

可能返回的错误码:

FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_BACKENDDOMAINERROR = "FailedOperation.BackendDomainError"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_EIAMERROR = "FailedOperation.EIAMError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException"
INTERNALERROR_CLBEXCEPTION = "InternalError.ClbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_BASICSERVICENOMOREAPI = "UnsupportedOperation.BasicServiceNoMoreApi"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_SERVICEEXIST = "UnsupportedOperation.ServiceExist"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"
UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType"

func (*Client) CreateIPStrategy

func (c *Client) CreateIPStrategy(request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)

CreateIPStrategy 本接口(CreateIPStrategy)用于创建服务IP策略。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) CreateIPStrategyWithContext added in v1.0.324

func (c *Client) CreateIPStrategyWithContext(ctx context.Context, request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)

CreateIPStrategy 本接口(CreateIPStrategy)用于创建服务IP策略。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) CreatePlugin added in v1.0.203

func (c *Client) CreatePlugin(request *CreatePluginRequest) (response *CreatePluginResponse, err error)

CreatePlugin 创建API网关插件。

可能返回的错误码:

FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreatePluginWithContext added in v1.0.324

func (c *Client) CreatePluginWithContext(ctx context.Context, request *CreatePluginRequest) (response *CreatePluginResponse, err error)

CreatePlugin 创建API网关插件。

可能返回的错误码:

FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateService

func (c *Client) CreateService(request *CreateServiceRequest) (response *CreateServiceResponse, err error)

CreateService 本接口(CreateService)用于创建服务。

API 网关使用的最大单元为服务,每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用,用户也可绑定自定义域名到此服务中。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR = "InternalError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded"
LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_ACCOUNTARREARS = "UnsupportedOperation.AccountArrears"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateServiceWithContext added in v1.0.324

func (c *Client) CreateServiceWithContext(ctx context.Context, request *CreateServiceRequest) (response *CreateServiceResponse, err error)

CreateService 本接口(CreateService)用于创建服务。

API 网关使用的最大单元为服务,每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用,用户也可绑定自定义域名到此服务中。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR = "InternalError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded"
LIMITEXCEEDED = "LimitExceeded"
LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded"
LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded"
MISSINGPARAMETER = "MissingParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser"
UNSUPPORTEDOPERATION_ACCOUNTARREARS = "UnsupportedOperation.AccountArrears"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateUpstream added in v1.0.357

func (c *Client) CreateUpstream(request *CreateUpstreamRequest) (response *CreateUpstreamResponse, err error)

CreateUpstream 用于创建后端通道

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OPERATEUPSTREAM = "FailedOperation.OperateUpstream"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateUpstreamWithContext added in v1.0.357

func (c *Client) CreateUpstreamWithContext(ctx context.Context, request *CreateUpstreamRequest) (response *CreateUpstreamResponse, err error)

CreateUpstream 用于创建后端通道

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OPERATEUPSTREAM = "FailedOperation.OperateUpstream"
FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateUsagePlan

func (c *Client) CreateUsagePlan(request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)

CreateUsagePlan 本接口(CreateUsagePlan)用于创建使用计划。

用户在使用 API 网关时,需要创建使用计划并将其绑定到服务的环境中使用。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDMAXREQUESTNUM = "InvalidParameterValue.InvalidMaxRequestNum"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) CreateUsagePlanWithContext added in v1.0.324

func (c *Client) CreateUsagePlanWithContext(ctx context.Context, request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)

CreateUsagePlan 本接口(CreateUsagePlan)用于创建使用计划。

用户在使用 API 网关时,需要创建使用计划并将其绑定到服务的环境中使用。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDMAXREQUESTNUM = "InvalidParameterValue.InvalidMaxRequestNum"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DeleteAPIDoc

func (c *Client) DeleteAPIDoc(request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)

DeleteAPIDoc 删除 API 文档

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteAPIDocWithContext added in v1.0.324

func (c *Client) DeleteAPIDocWithContext(ctx context.Context, request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)

DeleteAPIDoc 删除 API 文档

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteApi

func (c *Client) DeleteApi(request *DeleteApiRequest) (response *DeleteApiResponse, err error)

DeleteApi 本接口(DeleteApi)用于删除已经创建的API。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) DeleteApiApp added in v1.0.209

func (c *Client) DeleteApiApp(request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)

DeleteApiApp 本接口(DeleteApiApp)用于删除已经创建的应用。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) DeleteApiAppWithContext added in v1.0.324

func (c *Client) DeleteApiAppWithContext(ctx context.Context, request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)

DeleteApiApp 本接口(DeleteApiApp)用于删除已经创建的应用。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) DeleteApiKey

func (c *Client) DeleteApiKey(request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)

DeleteApiKey 本接口(DeleteApiKey)用于删除一对 API 密钥。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse"

func (*Client) DeleteApiKeyWithContext added in v1.0.324

func (c *Client) DeleteApiKeyWithContext(ctx context.Context, request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)

DeleteApiKey 本接口(DeleteApiKey)用于删除一对 API 密钥。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse"

func (*Client) DeleteApiWithContext added in v1.0.324

func (c *Client) DeleteApiWithContext(ctx context.Context, request *DeleteApiRequest) (response *DeleteApiResponse, err error)

DeleteApi 本接口(DeleteApi)用于删除已经创建的API。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) DeleteIPStrategy

func (c *Client) DeleteIPStrategy(request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)

DeleteIPStrategy 本接口(DeleteIPStrategy)用于删除服务IP策略。

可能返回的错误码:

RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) DeleteIPStrategyWithContext added in v1.0.324

func (c *Client) DeleteIPStrategyWithContext(ctx context.Context, request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)

DeleteIPStrategy 本接口(DeleteIPStrategy)用于删除服务IP策略。

可能返回的错误码:

RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) DeletePlugin added in v1.0.204

func (c *Client) DeletePlugin(request *DeletePluginRequest) (response *DeletePluginResponse, err error)

DeletePlugin 删除API网关插件

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DeletePluginWithContext added in v1.0.324

func (c *Client) DeletePluginWithContext(ctx context.Context, request *DeletePluginRequest) (response *DeletePluginResponse, err error)

DeletePlugin 删除API网关插件

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DeleteService

func (c *Client) DeleteService(request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)

DeleteService 本接口(DeleteService)用于删除 API 网关中某个服务。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_APILISTNOTEMPTY = "UnsupportedOperation.ApiListNotEmpty"
UNSUPPORTEDOPERATION_EXISTINGONLINEENVIRONMENT = "UnsupportedOperation.ExistingOnlineEnvironment"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_TAGSNOTEMPTY = "UnsupportedOperation.TagsNotEmpty"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService"
UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"

func (*Client) DeleteServiceSubDomainMapping

func (c *Client) DeleteServiceSubDomainMapping(request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)

DeleteServiceSubDomainMapping 本接口(DeleteServiceSubDomainMapping)用于删除服务中某个环境的自定义域名映射。

当用户使用自定义域名,并使用了自定义映射时,可使用此接口。但需注意,若删除了所有环境的映射时,调用此 API 均会返回失败。

可能返回的错误码:

FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) DeleteServiceSubDomainMappingWithContext added in v1.0.324

func (c *Client) DeleteServiceSubDomainMappingWithContext(ctx context.Context, request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)

DeleteServiceSubDomainMapping 本接口(DeleteServiceSubDomainMapping)用于删除服务中某个环境的自定义域名映射。

当用户使用自定义域名,并使用了自定义映射时,可使用此接口。但需注意,若删除了所有环境的映射时,调用此 API 均会返回失败。

可能返回的错误码:

FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) DeleteServiceWithContext added in v1.0.324

func (c *Client) DeleteServiceWithContext(ctx context.Context, request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)

DeleteService 本接口(DeleteService)用于删除 API 网关中某个服务。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_APILISTNOTEMPTY = "UnsupportedOperation.ApiListNotEmpty"
UNSUPPORTEDOPERATION_EXISTINGONLINEENVIRONMENT = "UnsupportedOperation.ExistingOnlineEnvironment"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_TAGSNOTEMPTY = "UnsupportedOperation.TagsNotEmpty"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService"
UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"

func (*Client) DeleteUpstream added in v1.0.357

func (c *Client) DeleteUpstream(request *DeleteUpstreamRequest) (response *DeleteUpstreamResponse, err error)

DeleteUpstream 删除后端通道,需要注意有API绑定时,不允许删除

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEUPSTREAM = "UnsupportedOperation.UnsupportedDeleteUpstream"

func (*Client) DeleteUpstreamWithContext added in v1.0.357

func (c *Client) DeleteUpstreamWithContext(ctx context.Context, request *DeleteUpstreamRequest) (response *DeleteUpstreamResponse, err error)

DeleteUpstream 删除后端通道,需要注意有API绑定时,不允许删除

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEUPSTREAM = "UnsupportedOperation.UnsupportedDeleteUpstream"

func (*Client) DeleteUsagePlan

func (c *Client) DeleteUsagePlan(request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)

DeleteUsagePlan 本接口(DeleteUsagePlan)用于删除使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"

func (*Client) DeleteUsagePlanWithContext added in v1.0.324

func (c *Client) DeleteUsagePlanWithContext(ctx context.Context, request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)

DeleteUsagePlan 本接口(DeleteUsagePlan)用于删除使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"

func (*Client) DemoteServiceUsagePlan

func (c *Client) DemoteServiceUsagePlan(request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)

DemoteServiceUsagePlan 本接口(DemoteServiceUsagePlan)用于将某个服务在某个环境的使用计划,降级到API上。

如果服务内没有API不允许进行此操作。

如果当前环境没有发布,不允许进行此操作。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv"

func (*Client) DemoteServiceUsagePlanWithContext added in v1.0.324

func (c *Client) DemoteServiceUsagePlanWithContext(ctx context.Context, request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)

DemoteServiceUsagePlan 本接口(DemoteServiceUsagePlan)用于将某个服务在某个环境的使用计划,降级到API上。

如果服务内没有API不允许进行此操作。

如果当前环境没有发布,不允许进行此操作。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv"

func (*Client) DescribeAPIDocDetail

func (c *Client) DescribeAPIDocDetail(request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)

DescribeAPIDocDetail 查询 API 文档详情

可能返回的错误码:

FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeAPIDocDetailWithContext added in v1.0.324

func (c *Client) DescribeAPIDocDetailWithContext(ctx context.Context, request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)

DescribeAPIDocDetail 查询 API 文档详情

可能返回的错误码:

FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeAPIDocs

func (c *Client) DescribeAPIDocs(request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)

DescribeAPIDocs 查询 API 文档列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeAPIDocsWithContext added in v1.0.324

func (c *Client) DescribeAPIDocsWithContext(ctx context.Context, request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)

DescribeAPIDocs 查询 API 文档列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeAllPluginApis added in v1.0.204

func (c *Client) DescribeAllPluginApis(request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)

DescribeAllPluginApis 展示插件相关的API列表,包括已绑定的和未绑定的API信息。

可能返回的错误码:

FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribeAllPluginApisWithContext added in v1.0.324

func (c *Client) DescribeAllPluginApisWithContext(ctx context.Context, request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)

DescribeAllPluginApis 展示插件相关的API列表,包括已绑定的和未绑定的API信息。

可能返回的错误码:

FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribeApi

func (c *Client) DescribeApi(request *DescribeApiRequest) (response *DescribeApiResponse, err error)

DescribeApi 本接口(DescribeApi)用于查询用户 API 网关的 API 接口的详细信息。​

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_DBEXCEPTION = "InternalError.DbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeApiApp added in v1.0.209

func (c *Client) DescribeApiApp(request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)

DescribeApiApp 本接口(DescribeApiApp)用于根据应用ID搜索应用。此接口已下线,如需使用功能请使用DescribeApiAppsStatus接口。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"

func (*Client) DescribeApiAppBindApisStatus added in v1.0.209

func (c *Client) DescribeApiAppBindApisStatus(request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)

DescribeApiAppBindApisStatus 本接口(DescribeApiAppBindApisStatus)查询应用绑定的Api列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribeApiAppBindApisStatusWithContext added in v1.0.324

func (c *Client) DescribeApiAppBindApisStatusWithContext(ctx context.Context, request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)

DescribeApiAppBindApisStatus 本接口(DescribeApiAppBindApisStatus)查询应用绑定的Api列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribeApiAppWithContext added in v1.0.324

func (c *Client) DescribeApiAppWithContext(ctx context.Context, request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)

DescribeApiApp 本接口(DescribeApiApp)用于根据应用ID搜索应用。此接口已下线,如需使用功能请使用DescribeApiAppsStatus接口。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"

func (*Client) DescribeApiAppsStatus added in v1.0.209

func (c *Client) DescribeApiAppsStatus(request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)

DescribeApiAppsStatus 本接口(DescribeApiAppsStatus)查询应用列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeApiAppsStatusWithContext added in v1.0.324

func (c *Client) DescribeApiAppsStatusWithContext(ctx context.Context, request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)

DescribeApiAppsStatus 本接口(DescribeApiAppsStatus)查询应用列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeApiBindApiAppsStatus added in v1.0.209

func (c *Client) DescribeApiBindApiAppsStatus(request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)

DescribeApiBindApiAppsStatus 本接口(DescribeApiBindApiAppsStatus)查询Api绑定的应用列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"

func (*Client) DescribeApiBindApiAppsStatusWithContext added in v1.0.324

func (c *Client) DescribeApiBindApiAppsStatusWithContext(ctx context.Context, request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)

DescribeApiBindApiAppsStatus 本接口(DescribeApiBindApiAppsStatus)查询Api绑定的应用列表。

可能返回的错误码:

INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"

func (*Client) DescribeApiEnvironmentStrategy

func (c *Client) DescribeApiEnvironmentStrategy(request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)

DescribeApiEnvironmentStrategy 本接口(DescribeApiEnvironmentStrategy)用于展示API绑定的限流策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeApiEnvironmentStrategyWithContext added in v1.0.324

func (c *Client) DescribeApiEnvironmentStrategyWithContext(ctx context.Context, request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)

DescribeApiEnvironmentStrategy 本接口(DescribeApiEnvironmentStrategy)用于展示API绑定的限流策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeApiForApiApp added in v1.0.217

func (c *Client) DescribeApiForApiApp(request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)

DescribeApiForApiApp 本接口(DescribeApiForApiApp)用于应用使用者查询部署于 API 网关的 API 接口的详细信息。​

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DescribeApiForApiAppWithContext added in v1.0.324

func (c *Client) DescribeApiForApiAppWithContext(ctx context.Context, request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)

DescribeApiForApiApp 本接口(DescribeApiForApiApp)用于应用使用者查询部署于 API 网关的 API 接口的详细信息。​

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DescribeApiKey

func (c *Client) DescribeApiKey(request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)

DescribeApiKey 本接口(DescribeApiKey)用于查询密钥详情。

用户在创建密钥后,可用此接口查询一个 API 密钥的详情,该接口会显示密钥 Key。

可能返回的错误码:

FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"

func (*Client) DescribeApiKeyWithContext added in v1.0.324

func (c *Client) DescribeApiKeyWithContext(ctx context.Context, request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)

DescribeApiKey 本接口(DescribeApiKey)用于查询密钥详情。

用户在创建密钥后,可用此接口查询一个 API 密钥的详情,该接口会显示密钥 Key。

可能返回的错误码:

FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"

func (*Client) DescribeApiKeysStatus

func (c *Client) DescribeApiKeysStatus(request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)

DescribeApiKeysStatus 本接口(DescribeApiKeysStatus)用于查询密钥列表。

当用户创建了多个密钥对时,可使用本接口查询一个或多个 API 密钥信息。

可能返回的错误码:

FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"

func (*Client) DescribeApiKeysStatusWithContext added in v1.0.324

func (c *Client) DescribeApiKeysStatusWithContext(ctx context.Context, request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)

DescribeApiKeysStatus 本接口(DescribeApiKeysStatus)用于查询密钥列表。

当用户创建了多个密钥对时,可使用本接口查询一个或多个 API 密钥信息。

可能返回的错误码:

FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"

func (*Client) DescribeApiUsagePlan

func (c *Client) DescribeApiUsagePlan(request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)

DescribeApiUsagePlan 本接口(DescribeApiUsagePlan)用于查询服务中 API 使用计划详情。

服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务及其中 API 的所有使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeApiUsagePlanWithContext added in v1.0.324

func (c *Client) DescribeApiUsagePlanWithContext(ctx context.Context, request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)

DescribeApiUsagePlan 本接口(DescribeApiUsagePlan)用于查询服务中 API 使用计划详情。

服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务及其中 API 的所有使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeApiWithContext added in v1.0.324

func (c *Client) DescribeApiWithContext(ctx context.Context, request *DescribeApiRequest) (response *DescribeApiResponse, err error)

DescribeApi 本接口(DescribeApi)用于查询用户 API 网关的 API 接口的详细信息。​

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INTERNALERROR = "InternalError"
INTERNALERROR_DBEXCEPTION = "InternalError.DbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeApisStatus

func (c *Client) DescribeApisStatus(request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)

DescribeApisStatus 本接口(DescribeApisStatus)用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。

可能返回的错误码:

FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeApisStatusWithContext added in v1.0.324

func (c *Client) DescribeApisStatusWithContext(ctx context.Context, request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)

DescribeApisStatus 本接口(DescribeApisStatus)用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。

可能返回的错误码:

FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeExclusiveInstanceDetail added in v1.0.288

func (c *Client) DescribeExclusiveInstanceDetail(request *DescribeExclusiveInstanceDetailRequest) (response *DescribeExclusiveInstanceDetailResponse, err error)

DescribeExclusiveInstanceDetail 本接口(DescribeExclusiveInstanceDetail)用于查询独享实例详情信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
INTERNALERROR = "InternalError"
LIMITEXCEEDED = "LimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDINSTANCESTATE = "UnsupportedOperation.InvalidInstanceState"

func (*Client) DescribeExclusiveInstanceDetailWithContext added in v1.0.324

func (c *Client) DescribeExclusiveInstanceDetailWithContext(ctx context.Context, request *DescribeExclusiveInstanceDetailRequest) (response *DescribeExclusiveInstanceDetailResponse, err error)

DescribeExclusiveInstanceDetail 本接口(DescribeExclusiveInstanceDetail)用于查询独享实例详情信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
INTERNALERROR = "InternalError"
LIMITEXCEEDED = "LimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDINSTANCESTATE = "UnsupportedOperation.InvalidInstanceState"

func (*Client) DescribeExclusiveInstances added in v1.0.288

func (c *Client) DescribeExclusiveInstances(request *DescribeExclusiveInstancesRequest) (response *DescribeExclusiveInstancesResponse, err error)

DescribeExclusiveInstances 本接口(DescribeExclusiveInstances)用于查询独享实例列表信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeExclusiveInstancesStatus added in v1.0.419

func (c *Client) DescribeExclusiveInstancesStatus(request *DescribeExclusiveInstancesStatusRequest) (response *DescribeExclusiveInstancesStatusResponse, err error)

DescribeExclusiveInstancesStatus 查询专享实例列表(新)

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeExclusiveInstancesStatusWithContext added in v1.0.419

func (c *Client) DescribeExclusiveInstancesStatusWithContext(ctx context.Context, request *DescribeExclusiveInstancesStatusRequest) (response *DescribeExclusiveInstancesStatusResponse, err error)

DescribeExclusiveInstancesStatus 查询专享实例列表(新)

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeExclusiveInstancesWithContext added in v1.0.324

func (c *Client) DescribeExclusiveInstancesWithContext(ctx context.Context, request *DescribeExclusiveInstancesRequest) (response *DescribeExclusiveInstancesResponse, err error)

DescribeExclusiveInstances 本接口(DescribeExclusiveInstances)用于查询独享实例列表信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CLSERROR = "FailedOperation.ClsError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeIPStrategy

func (c *Client) DescribeIPStrategy(request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)

DescribeIPStrategy 本接口(DescribeIPStrategy)用于查询IP策略详情。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeIPStrategyApisStatus

func (c *Client) DescribeIPStrategyApisStatus(request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)

DescribeIPStrategyApisStatus 本接口(DescribeIPStrategyApisStatus)用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) DescribeIPStrategyApisStatusWithContext added in v1.0.324

func (c *Client) DescribeIPStrategyApisStatusWithContext(ctx context.Context, request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)

DescribeIPStrategyApisStatus 本接口(DescribeIPStrategyApisStatus)用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) DescribeIPStrategyWithContext added in v1.0.324

func (c *Client) DescribeIPStrategyWithContext(ctx context.Context, request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)

DescribeIPStrategy 本接口(DescribeIPStrategy)用于查询IP策略详情。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeIPStrategysStatus

func (c *Client) DescribeIPStrategysStatus(request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)

DescribeIPStrategysStatus 本接口(DescribeIPStrategysStatus)用于查询服务IP策略列表,因为接口名拼写错误,已不推荐使用,请优先使用DescribeIPStrategiesStatus接口。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeIPStrategysStatusWithContext added in v1.0.324

func (c *Client) DescribeIPStrategysStatusWithContext(ctx context.Context, request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)

DescribeIPStrategysStatus 本接口(DescribeIPStrategysStatus)用于查询服务IP策略列表,因为接口名拼写错误,已不推荐使用,请优先使用DescribeIPStrategiesStatus接口。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeLogSearch

func (c *Client) DescribeLogSearch(request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)

DescribeLogSearch 本接口DescribeLogSearch用于搜索日志

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_CLSSEARCHTIME = "UnsupportedOperation.ClsSearchTime"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribeLogSearchWithContext added in v1.0.324

func (c *Client) DescribeLogSearchWithContext(ctx context.Context, request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)

DescribeLogSearch 本接口DescribeLogSearch用于搜索日志

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_CLSSEARCHTIME = "UnsupportedOperation.ClsSearchTime"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribePlugin added in v1.0.204

func (c *Client) DescribePlugin(request *DescribePluginRequest) (response *DescribePluginResponse, err error)

DescribePlugin 展示插件详情,支持按照插件ID进行。

可能返回的错误码:

INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribePluginApis added in v1.0.204

func (c *Client) DescribePluginApis(request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)

DescribePluginApis 查询指定插件下绑定的API信息

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribePluginApisWithContext added in v1.0.324

func (c *Client) DescribePluginApisWithContext(ctx context.Context, request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)

DescribePluginApis 查询指定插件下绑定的API信息

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribePluginWithContext added in v1.0.324

func (c *Client) DescribePluginWithContext(ctx context.Context, request *DescribePluginRequest) (response *DescribePluginResponse, err error)

DescribePlugin 展示插件详情,支持按照插件ID进行。

可能返回的错误码:

INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"

func (*Client) DescribePlugins

func (c *Client) DescribePlugins(request *DescribePluginsRequest) (response *DescribePluginsResponse, err error)

DescribePlugins 展示插件列表和详情,支持分页,支持按照插件类型查询,支持按照插件ID批量查询,支持按照插件名称查询。

可能返回的错误码:

INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribePluginsByApi added in v1.0.533

func (c *Client) DescribePluginsByApi(request *DescribePluginsByApiRequest) (response *DescribePluginsByApiResponse, err error)

DescribePluginsByApi 展示API上已绑定的插件列表。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribePluginsByApiWithContext added in v1.0.533

func (c *Client) DescribePluginsByApiWithContext(ctx context.Context, request *DescribePluginsByApiRequest) (response *DescribePluginsByApiResponse, err error)

DescribePluginsByApi 展示API上已绑定的插件列表。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"

func (*Client) DescribePluginsWithContext added in v1.0.324

func (c *Client) DescribePluginsWithContext(ctx context.Context, request *DescribePluginsRequest) (response *DescribePluginsResponse, err error)

DescribePlugins 展示插件列表和详情,支持分页,支持按照插件类型查询,支持按照插件ID批量查询,支持按照插件名称查询。

可能返回的错误码:

INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeService

func (c *Client) DescribeService(request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)

DescribeService 本接口(DescribeService)用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DescribeServiceEnvironmentList

func (c *Client) DescribeServiceEnvironmentList(request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)

DescribeServiceEnvironmentList 本接口(DescribeServiceEnvironmentList)用于查询一个服务的环境列表,可查询到此服务下所有环境及其状态。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceEnvironmentListWithContext added in v1.0.324

func (c *Client) DescribeServiceEnvironmentListWithContext(ctx context.Context, request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)

DescribeServiceEnvironmentList 本接口(DescribeServiceEnvironmentList)用于查询一个服务的环境列表,可查询到此服务下所有环境及其状态。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceEnvironmentReleaseHistory

func (c *Client) DescribeServiceEnvironmentReleaseHistory(request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)

DescribeServiceEnvironmentReleaseHistory 本接口(DescribeServiceEnvironmentReleaseHistory)用于查询服务环境的发布历史。

用户在创建好服务后需要发布到某个环境中才能进行使用,本接口用于查询一个服务某个环境的发布记录。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceEnvironmentReleaseHistoryWithContext added in v1.0.324

func (c *Client) DescribeServiceEnvironmentReleaseHistoryWithContext(ctx context.Context, request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)

DescribeServiceEnvironmentReleaseHistory 本接口(DescribeServiceEnvironmentReleaseHistory)用于查询服务环境的发布历史。

用户在创建好服务后需要发布到某个环境中才能进行使用,本接口用于查询一个服务某个环境的发布记录。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceEnvironmentStrategy

func (c *Client) DescribeServiceEnvironmentStrategy(request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)

DescribeServiceEnvironmentStrategy 本接口(DescribeServiceEnvironmentStrategy)用于展示服务限流策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceEnvironmentStrategyWithContext added in v1.0.324

func (c *Client) DescribeServiceEnvironmentStrategyWithContext(ctx context.Context, request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)

DescribeServiceEnvironmentStrategy 本接口(DescribeServiceEnvironmentStrategy)用于展示服务限流策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceForApiApp added in v1.0.209

func (c *Client) DescribeServiceForApiApp(request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)

DescribeServiceForApiApp 本接口(DescribeServiceForApiApp)用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceForApiAppWithContext added in v1.0.324

func (c *Client) DescribeServiceForApiAppWithContext(ctx context.Context, request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)

DescribeServiceForApiApp 本接口(DescribeServiceForApiApp)用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceReleaseVersion

func (c *Client) DescribeServiceReleaseVersion(request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)

DescribeServiceReleaseVersion 本接口(DescribeServiceReleaseVersion)查询一个服务下面所有已经发布的版本列表。

用户在发布服务时,常有多个版本发布,可使用本接口查询已发布的版本。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceReleaseVersionWithContext added in v1.0.324

func (c *Client) DescribeServiceReleaseVersionWithContext(ctx context.Context, request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)

DescribeServiceReleaseVersion 本接口(DescribeServiceReleaseVersion)查询一个服务下面所有已经发布的版本列表。

用户在发布服务时,常有多个版本发布,可使用本接口查询已发布的版本。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceSubDomainMappings

func (c *Client) DescribeServiceSubDomainMappings(request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)

DescribeServiceSubDomainMappings 本接口(DescribeServiceSubDomainMappings)用于查询自定义域名的路径映射。

API 网关可绑定自定义域名到服务,并且可以对自定义域名的路径进行映射,可自定义不同的路径映射到服务中的三个环境,本接口用于查询绑定服务的自定义域名的路径映射列表。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceSubDomainMappingsWithContext added in v1.0.324

func (c *Client) DescribeServiceSubDomainMappingsWithContext(ctx context.Context, request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)

DescribeServiceSubDomainMappings 本接口(DescribeServiceSubDomainMappings)用于查询自定义域名的路径映射。

API 网关可绑定自定义域名到服务,并且可以对自定义域名的路径进行映射,可自定义不同的路径映射到服务中的三个环境,本接口用于查询绑定服务的自定义域名的路径映射列表。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceSubDomains

func (c *Client) DescribeServiceSubDomains(request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)

DescribeServiceSubDomains 本接口(DescribeServiceSubDomains)用于查询自定义域名列表。

API 网关可绑定自定义域名到服务,用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。

可能返回的错误码:

FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceSubDomainsWithContext added in v1.0.324

func (c *Client) DescribeServiceSubDomainsWithContext(ctx context.Context, request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)

DescribeServiceSubDomains 本接口(DescribeServiceSubDomains)用于查询自定义域名列表。

API 网关可绑定自定义域名到服务,用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。

可能返回的错误码:

FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceUsagePlan

func (c *Client) DescribeServiceUsagePlan(request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)

DescribeServiceUsagePlan 本接口(DescribeServiceUsagePlan)用于查询服务使用计划详情。

服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务的所有使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceUsagePlanWithContext added in v1.0.324

func (c *Client) DescribeServiceUsagePlanWithContext(ctx context.Context, request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)

DescribeServiceUsagePlan 本接口(DescribeServiceUsagePlan)用于查询服务使用计划详情。

服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务的所有使用计划。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) DescribeServiceWithContext added in v1.0.324

func (c *Client) DescribeServiceWithContext(ctx context.Context, request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)

DescribeService 本接口(DescribeService)用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DescribeServicesStatus

func (c *Client) DescribeServicesStatus(request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)

DescribeServicesStatus 本接口(DescribeServicesStatus)用于搜索查询某一个服务或多个服务的列表,并返回服务相关的域名、时间等信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INTERNALERROR_DBEXCEPTION = "InternalError.DbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeServicesStatusWithContext added in v1.0.324

func (c *Client) DescribeServicesStatusWithContext(ctx context.Context, request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)

DescribeServicesStatus 本接口(DescribeServicesStatus)用于搜索查询某一个服务或多个服务的列表,并返回服务相关的域名、时间等信息。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INTERNALERROR_DBEXCEPTION = "InternalError.DbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeUpstreamBindApis added in v1.0.357

func (c *Client) DescribeUpstreamBindApis(request *DescribeUpstreamBindApisRequest) (response *DescribeUpstreamBindApisResponse, err error)

DescribeUpstreamBindApis 查询后端通道所绑定的API列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeUpstreamBindApisWithContext added in v1.0.357

func (c *Client) DescribeUpstreamBindApisWithContext(ctx context.Context, request *DescribeUpstreamBindApisRequest) (response *DescribeUpstreamBindApisResponse, err error)

DescribeUpstreamBindApis 查询后端通道所绑定的API列表

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeUpstreams added in v1.0.357

func (c *Client) DescribeUpstreams(request *DescribeUpstreamsRequest) (response *DescribeUpstreamsResponse, err error)

DescribeUpstreams 查询后端通道列表详情

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeUpstreamsWithContext added in v1.0.357

func (c *Client) DescribeUpstreamsWithContext(ctx context.Context, request *DescribeUpstreamsRequest) (response *DescribeUpstreamsResponse, err error)

DescribeUpstreams 查询后端通道列表详情

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_CAMEXCEPTION = "FailedOperation.CamException"
INTERNALERROR = "InternalError"
INTERNALERROR_CAMEXCEPTION = "InternalError.CamException"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) DescribeUsagePlan

func (c *Client) DescribeUsagePlan(request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)

DescribeUsagePlan 本接口(DescribeUsagePlan)用于查询一个使用计划的详细信息,包括名称、QPS、创建时间绑定的环境等。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlanEnvironments

func (c *Client) DescribeUsagePlanEnvironments(request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)

DescribeUsagePlanEnvironments 本接口(DescribeUsagePlanEnvironments)用于查询使用计划绑定的环境列表。

用户在绑定了某个使用计划到环境后,可使用本接口查询这个使用计划绑定的所有服务的环境。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlanEnvironmentsWithContext added in v1.0.324

func (c *Client) DescribeUsagePlanEnvironmentsWithContext(ctx context.Context, request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)

DescribeUsagePlanEnvironments 本接口(DescribeUsagePlanEnvironments)用于查询使用计划绑定的环境列表。

用户在绑定了某个使用计划到环境后,可使用本接口查询这个使用计划绑定的所有服务的环境。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlanSecretIds

func (c *Client) DescribeUsagePlanSecretIds(request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)

DescribeUsagePlanSecretIds 本接口(DescribeUsagePlanSecretIds)用于查询使用计划绑定的密钥列表。

在 API 网关中,一个使用计划可绑定多个密钥对,可使用本接口查询使用计划绑定的密钥列表。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlanSecretIdsWithContext added in v1.0.324

func (c *Client) DescribeUsagePlanSecretIdsWithContext(ctx context.Context, request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)

DescribeUsagePlanSecretIds 本接口(DescribeUsagePlanSecretIds)用于查询使用计划绑定的密钥列表。

在 API 网关中,一个使用计划可绑定多个密钥对,可使用本接口查询使用计划绑定的密钥列表。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlanWithContext added in v1.0.324

func (c *Client) DescribeUsagePlanWithContext(ctx context.Context, request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)

DescribeUsagePlan 本接口(DescribeUsagePlan)用于查询一个使用计划的详细信息,包括名称、QPS、创建时间绑定的环境等。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) DescribeUsagePlansStatus

func (c *Client) DescribeUsagePlansStatus(request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)

DescribeUsagePlansStatus 本接口(DescribeUsagePlanStatus)用于查询使用计划的列表。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"

func (*Client) DescribeUsagePlansStatusWithContext added in v1.0.324

func (c *Client) DescribeUsagePlansStatusWithContext(ctx context.Context, request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)

DescribeUsagePlansStatus 本接口(DescribeUsagePlanStatus)用于查询使用计划的列表。

可能返回的错误码:

INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"

func (*Client) DetachPlugin added in v1.0.204

func (c *Client) DetachPlugin(request *DetachPluginRequest) (response *DetachPluginResponse, err error)

DetachPlugin 解除插件与API绑定

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DetachPluginWithContext added in v1.0.324

func (c *Client) DetachPluginWithContext(ctx context.Context, request *DetachPluginRequest) (response *DetachPluginResponse, err error)

DetachPlugin 解除插件与API绑定

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds"
INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) DisableApiKey

func (c *Client) DisableApiKey(request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)

DisableApiKey 本接口(DisableApiKey)用于禁用一对 API 密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"

func (*Client) DisableApiKeyWithContext added in v1.0.324

func (c *Client) DisableApiKeyWithContext(ctx context.Context, request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)

DisableApiKey 本接口(DisableApiKey)用于禁用一对 API 密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"

func (*Client) EnableApiKey

func (c *Client) EnableApiKey(request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)

EnableApiKey 本接口(EnableApiKey)用于启动一对被禁用的 API 密钥。

可能返回的错误码:

RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"

func (*Client) EnableApiKeyWithContext added in v1.0.324

func (c *Client) EnableApiKeyWithContext(ctx context.Context, request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)

EnableApiKey 本接口(EnableApiKey)用于启动一对被禁用的 API 密钥。

可能返回的错误码:

RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"

func (*Client) ImportOpenApi added in v1.0.482

func (c *Client) ImportOpenApi(request *ImportOpenApiRequest) (response *ImportOpenApiResponse, err error)

ImportOpenApi 本接口(ImportOpenApi)用于将OpenAPI规范定义的API导入到API网关。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
INTERNALERROR = "InternalError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_UNSUPPORTEDPARAMETER = "InvalidParameterValue.UnsupportedParameter"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ImportOpenApiWithContext added in v1.0.482

func (c *Client) ImportOpenApiWithContext(ctx context.Context, request *ImportOpenApiRequest) (response *ImportOpenApiResponse, err error)

ImportOpenApi 本接口(ImportOpenApi)用于将OpenAPI规范定义的API导入到API网关。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
INTERNALERROR = "InternalError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_UNSUPPORTEDPARAMETER = "InvalidParameterValue.UnsupportedParameter"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyAPIDoc

func (c *Client) ModifyAPIDoc(request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)

ModifyAPIDoc 修改 API 文档

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyAPIDocWithContext added in v1.0.324

func (c *Client) ModifyAPIDocWithContext(ctx context.Context, request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)

ModifyAPIDoc 修改 API 文档

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyApi

func (c *Client) ModifyApi(request *ModifyApiRequest) (response *ModifyApiResponse, err error)

ModifyApi 本接口(ModifyApi)用于修改 API 接口,可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_BACKENDDOMAINERROR = "FailedOperation.BackendDomainError"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_EIAMERROR = "FailedOperation.EIAMError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CLBEXCEPTION = "InternalError.ClbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_BASICSERVICENOTALLOWATTACHPLUGIN = "InvalidParameter.BasicServiceNotAllowAttachPlugin"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi"
UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyApiApp added in v1.0.209

func (c *Client) ModifyApiApp(request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)

ModifyApiApp 本接口(ModifyApiApp)用于修改已经创建的应用。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) ModifyApiAppWithContext added in v1.0.324

func (c *Client) ModifyApiAppWithContext(ctx context.Context, request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)

ModifyApiApp 本接口(ModifyApiApp)用于修改已经创建的应用。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) ModifyApiEnvironmentStrategy

func (c *Client) ModifyApiEnvironmentStrategy(request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)

ModifyApiEnvironmentStrategy 本接口(ModifyApiEnvironmentStrategy)用于修改API限流策略

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"

func (*Client) ModifyApiEnvironmentStrategyWithContext added in v1.0.324

func (c *Client) ModifyApiEnvironmentStrategyWithContext(ctx context.Context, request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)

ModifyApiEnvironmentStrategy 本接口(ModifyApiEnvironmentStrategy)用于修改API限流策略

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"

func (*Client) ModifyApiIncrement

func (c *Client) ModifyApiIncrement(request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)

ModifyApiIncrement 提供增量更新API能力,主要是给程序调用(区别于ModifyApi,该接口是需要传入API的全量参数,对console使用较友好)

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyApiIncrementWithContext added in v1.0.324

func (c *Client) ModifyApiIncrementWithContext(ctx context.Context, request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)

ModifyApiIncrement 提供增量更新API能力,主要是给程序调用(区别于ModifyApi,该接口是需要传入API的全量参数,对console使用较友好)

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyApiWithContext added in v1.0.324

func (c *Client) ModifyApiWithContext(ctx context.Context, request *ModifyApiRequest) (response *ModifyApiResponse, err error)

ModifyApi 本接口(ModifyApi)用于修改 API 接口,可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_BACKENDDOMAINERROR = "FailedOperation.BackendDomainError"
FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian"
FAILEDOPERATION_EIAMERROR = "FailedOperation.EIAMError"
FAILEDOPERATION_EBERROR = "FailedOperation.EbError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_CLBEXCEPTION = "InternalError.ClbException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_BASICSERVICENOTALLOWATTACHPLUGIN = "InvalidParameter.BasicServiceNotAllowAttachPlugin"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp"
INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType"
UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi"
UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyExclusiveInstance added in v1.0.288

func (c *Client) ModifyExclusiveInstance(request *ModifyExclusiveInstanceRequest) (response *ModifyExclusiveInstanceResponse, err error)

ModifyExclusiveInstance 本接口(ModifyExclusiveInstance)用于修改独享实例信息。​

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDINSTANCESTATE = "UnsupportedOperation.InvalidInstanceState"

func (*Client) ModifyExclusiveInstanceWithContext added in v1.0.324

func (c *Client) ModifyExclusiveInstanceWithContext(ctx context.Context, request *ModifyExclusiveInstanceRequest) (response *ModifyExclusiveInstanceResponse, err error)

ModifyExclusiveInstance 本接口(ModifyExclusiveInstance)用于修改独享实例信息。​

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist"
FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen"
FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDINSTANCESTATE = "UnsupportedOperation.InvalidInstanceState"

func (*Client) ModifyIPStrategy

func (c *Client) ModifyIPStrategy(request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)

ModifyIPStrategy 本接口(ModifyIPStrategy)用于修改服务IP策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) ModifyIPStrategyWithContext added in v1.0.324

func (c *Client) ModifyIPStrategyWithContext(ctx context.Context, request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)

ModifyIPStrategy 本接口(ModifyIPStrategy)用于修改服务IP策略。

可能返回的错误码:

INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"

func (*Client) ModifyPlugin added in v1.0.204

func (c *Client) ModifyPlugin(request *ModifyPluginRequest) (response *ModifyPluginResponse, err error)

ModifyPlugin 修改API网关插件。

可能返回的错误码:

FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_INVALIDINPUTJSON = "FailedOperation.InvalidInputJSON"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyPluginWithContext added in v1.0.324

func (c *Client) ModifyPluginWithContext(ctx context.Context, request *ModifyPluginRequest) (response *ModifyPluginResponse, err error)

ModifyPlugin 修改API网关插件。

可能返回的错误码:

FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
FAILEDOPERATION_INVALIDINPUTJSON = "FailedOperation.InvalidInputJSON"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException"
INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig"
INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig"
INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath"
INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb"
INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition"
INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress"
INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig"
INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig"
INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam"
INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType"
INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam"
MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig"
RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin"
UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyService

func (c *Client) ModifyService(request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)

ModifyService 本接口(ModifyService)用于修改服务的相关信息。当服务创建后,服务的名称、描述和服务类型均可被修改。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType"
UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifyServiceEnvironmentStrategy

func (c *Client) ModifyServiceEnvironmentStrategy(request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)

ModifyServiceEnvironmentStrategy 本接口(ModifyServiceEnvironmentStrategy)用于修改服务限流策略

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyServiceEnvironmentStrategyWithContext added in v1.0.324

func (c *Client) ModifyServiceEnvironmentStrategyWithContext(ctx context.Context, request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)

ModifyServiceEnvironmentStrategy 本接口(ModifyServiceEnvironmentStrategy)用于修改服务限流策略

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"

func (*Client) ModifyServiceWithContext added in v1.0.324

func (c *Client) ModifyServiceWithContext(ctx context.Context, request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)

ModifyService 本接口(ModifyService)用于修改服务的相关信息。当服务创建后,服务的名称、描述和服务类型均可被修改。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType"
UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ModifySubDomain

func (c *Client) ModifySubDomain(request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)

ModifySubDomain 本接口(ModifySubDomain)用于修改服务的自定义域名设置中的路径映射,可以修改绑定自定义域名之前的路径映射规则。

可能返回的错误码:

FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError"
FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError"
FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) ModifySubDomainWithContext added in v1.0.324

func (c *Client) ModifySubDomainWithContext(ctx context.Context, request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)

ModifySubDomain 本接口(ModifySubDomain)用于修改服务的自定义域名设置中的路径映射,可以修改绑定自定义域名之前的路径映射规则。

可能返回的错误码:

FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError"
FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError"
FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) ModifyUpstream added in v1.0.357

func (c *Client) ModifyUpstream(request *ModifyUpstreamRequest) (response *ModifyUpstreamResponse, err error)

ModifyUpstream 修改后端通道

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OPERATEUPSTREAM = "FailedOperation.OperateUpstream"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyUpstreamWithContext added in v1.0.357

func (c *Client) ModifyUpstreamWithContext(ctx context.Context, request *ModifyUpstreamRequest) (response *ModifyUpstreamResponse, err error)

ModifyUpstream 修改后端通道

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_OPERATEUPSTREAM = "FailedOperation.OperateUpstream"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream"
INVALIDPARAMETERVALUE_INVALIDVPCCONFIG = "InvalidParameterValue.InvalidVpcConfig"
INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyUsagePlan

func (c *Client) ModifyUsagePlan(request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)

ModifyUsagePlan 本接口(ModifyUsagePlan)用于修改使用计划的名称,描述及 QPS。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) ModifyUsagePlanWithContext added in v1.0.324

func (c *Client) ModifyUsagePlanWithContext(ctx context.Context, request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)

ModifyUsagePlan 本接口(ModifyUsagePlan)用于修改使用计划的名称,描述及 QPS。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"

func (*Client) ReleaseService

func (c *Client) ReleaseService(request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)

ReleaseService 本接口(ReleaseService)用于发布服务。

API 网关的服务创建后,需要发布到某个环境方生效后,使用者才能进行调用,此接口用于发布服务到环境,如 release 环境。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ReleaseServiceWithContext added in v1.0.324

func (c *Client) ReleaseServiceWithContext(ctx context.Context, request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)

ReleaseService 本接口(ReleaseService)用于发布服务。

API 网关的服务创建后,需要发布到某个环境方生效后,使用者才能进行调用,此接口用于发布服务到环境,如 release 环境。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_TASKALREADYEXIST = "FailedOperation.TaskAlreadyExist"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) ResetAPIDocPassword

func (c *Client) ResetAPIDocPassword(request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)

ResetAPIDocPassword 重置API文档密码

可能返回的错误码:

FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"

func (*Client) ResetAPIDocPasswordWithContext added in v1.0.324

func (c *Client) ResetAPIDocPasswordWithContext(ctx context.Context, request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)

ResetAPIDocPassword 重置API文档密码

可能返回的错误码:

FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"

func (*Client) UnBindEnvironment

func (c *Client) UnBindEnvironment(request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)

UnBindEnvironment 本接口(UnBindEnvironment)用于将使用计划从特定环境解绑。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"

func (*Client) UnBindEnvironmentWithContext added in v1.0.324

func (c *Client) UnBindEnvironmentWithContext(ctx context.Context, request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)

UnBindEnvironment 本接口(UnBindEnvironment)用于将使用计划从特定环境解绑。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"

func (*Client) UnBindIPStrategy

func (c *Client) UnBindIPStrategy(request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)

UnBindIPStrategy 本接口(UnBindIPStrategy)用于服务解绑IP策略。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"

func (*Client) UnBindIPStrategyWithContext added in v1.0.324

func (c *Client) UnBindIPStrategyWithContext(ctx context.Context, request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)

UnBindIPStrategy 本接口(UnBindIPStrategy)用于服务解绑IP策略。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"

func (*Client) UnBindSecretIds

func (c *Client) UnBindSecretIds(request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)

UnBindSecretIds 本接口(UnBindSecretIds)用于为使用计划解绑密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) UnBindSecretIdsWithContext added in v1.0.324

func (c *Client) UnBindSecretIdsWithContext(ctx context.Context, request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)

UnBindSecretIds 本接口(UnBindSecretIds)用于为使用计划解绑密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
UNSUPPORTEDOPERATION_REQUESTPOSTERROR = "UnsupportedOperation.RequestPostError"

func (*Client) UnBindSubDomain

func (c *Client) UnBindSubDomain(request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)

UnBindSubDomain 本接口(UnBindSubDomain)用于解绑自定义域名。

用户使用 API 网关绑定了自定义域名到服务中后,若想要解绑此自定义域名,可使用此接口。

可能返回的错误码:

FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) UnBindSubDomainWithContext added in v1.0.324

func (c *Client) UnBindSubDomainWithContext(ctx context.Context, request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)

UnBindSubDomain 本接口(UnBindSubDomain)用于解绑自定义域名。

用户使用 API 网关绑定了自定义域名到服务中后,若想要解绑此自定义域名,可使用此接口。

可能返回的错误码:

FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService"
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist"
FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) UnReleaseService

func (c *Client) UnReleaseService(request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)

UnReleaseService 本接口(UnReleaseService)用于下线服务。

用户发布服务到某个环境后,此服务中的 API 方可被调用者进行调用,当用户需要将此服务从发布环境中下线时,可调用此 API。下线后的服务不可被调用。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) UnReleaseServiceWithContext added in v1.0.324

func (c *Client) UnReleaseServiceWithContext(ctx context.Context, request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)

UnReleaseService 本接口(UnReleaseService)用于下线服务。

用户发布服务到某个环境后,此服务中的 API 方可被调用者进行调用,当用户需要将此服务从发布环境中下线时,可调用此 API。下线后的服务不可被调用。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNPACKERROR = "UnsupportedOperation.UnpackError"

func (*Client) UnbindApiApp added in v1.0.209

func (c *Client) UnbindApiApp(request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)

UnbindApiApp 本接口(UnbindApiApp)用于解除应用和API绑定。

可能返回的错误码:

FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"

func (*Client) UnbindApiAppWithContext added in v1.0.324

func (c *Client) UnbindApiAppWithContext(ctx context.Context, request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)

UnbindApiApp 本接口(UnbindApiApp)用于解除应用和API绑定。

可能返回的错误码:

FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_RETURNABLEEXCEPTION = "InternalError.ReturnableException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"

func (*Client) UpdateApiAppKey added in v1.0.209

func (c *Client) UpdateApiAppKey(request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)

UpdateApiAppKey 本接口(UpdateApiAppKey)用于更新应用密钥。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) UpdateApiAppKeyWithContext added in v1.0.324

func (c *Client) UpdateApiAppKeyWithContext(ctx context.Context, request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)

UpdateApiAppKey 本接口(UpdateApiAppKey)用于更新应用密钥。

可能返回的错误码:

FAILEDOPERATION_APIERROR = "FailedOperation.ApiError"
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation"
FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError"
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp"
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"

func (*Client) UpdateApiKey

func (c *Client) UpdateApiKey(request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)

UpdateApiKey 本接口(UpdateApiKey)用于更换用户已创建的一对 API 密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"

func (*Client) UpdateApiKeyWithContext added in v1.0.324

func (c *Client) UpdateApiKeyWithContext(ctx context.Context, request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)

UpdateApiKey 本接口(UpdateApiKey)用于更换用户已创建的一对 API 密钥。

可能返回的错误码:

INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"

func (*Client) UpdateService

func (c *Client) UpdateService(request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)

UpdateService 本接口(UpdateService)用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后,如在开发过程产生多个版本需要切换,此时可调用本接口。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

func (*Client) UpdateServiceWithContext added in v1.0.324

func (c *Client) UpdateServiceWithContext(ctx context.Context, request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)

UpdateService 本接口(UpdateService)用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后,如在开发过程产生多个版本需要切换,此时可调用本接口。

可能返回的错误码:

FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError"
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation"
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException"
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"

type ConstantParameter

type ConstantParameter struct {
	// 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Position *string `json:"Position,omitnil,omitempty" name:"Position"`

	// 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`
}

type CosConfig added in v1.0.327

type CosConfig struct {
	// API调用后端COS的方式,前端请求方法与Action的可选值为:
	// GET:GetObject
	// PUT:PutObject
	// POST:PostObject、AppendObject
	// HEAD: HeadObject
	// DELETE: DeleteObject。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Action *string `json:"Action,omitnil,omitempty" name:"Action"`

	// API后端COS的存储桶名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BucketName *string `json:"BucketName,omitnil,omitempty" name:"BucketName"`

	// API调用后端COS的签名开关,默认为false。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Authorization *bool `json:"Authorization,omitnil,omitempty" name:"Authorization"`

	// API后端COS的路径匹配模式,可选值:
	// BackEndPath : 后端路径匹配
	// FullPath : 全路径匹配
	//
	// 默认值为:BackEndPath
	// 注意:此字段可能返回 null,表示取不到有效值。
	PathMatchMode *string `json:"PathMatchMode,omitnil,omitempty" name:"PathMatchMode"`
}

type CreateAPIDocRequest

type CreateAPIDocRequest struct {
	*tchttp.BaseRequest

	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// 服务名称
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 生成文档的API列表
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreateAPIDocRequest

func NewCreateAPIDocRequest() (request *CreateAPIDocRequest)

func (*CreateAPIDocRequest) FromJsonString

func (r *CreateAPIDocRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAPIDocRequest) ToJsonString

func (r *CreateAPIDocRequest) ToJsonString() string

type CreateAPIDocRequestParams added in v1.0.426

type CreateAPIDocRequestParams struct {
	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// 服务名称
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 生成文档的API列表
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateAPIDocResponse

type CreateAPIDocResponse struct {
	*tchttp.BaseResponse
	Response *CreateAPIDocResponseParams `json:"Response"`
}

func NewCreateAPIDocResponse

func NewCreateAPIDocResponse() (response *CreateAPIDocResponse)

func (*CreateAPIDocResponse) FromJsonString

func (r *CreateAPIDocResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAPIDocResponse) ToJsonString

func (r *CreateAPIDocResponse) ToJsonString() string

type CreateAPIDocResponseParams added in v1.0.426

type CreateAPIDocResponseParams struct {
	// API文档基本信息
	Result *APIDoc `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateApiAppRequest added in v1.0.209

type CreateApiAppRequest struct {
	*tchttp.BaseRequest

	// 用户自定义应用名称。
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 应用描述
	ApiAppDesc *string `json:"ApiAppDesc,omitnil,omitempty" name:"ApiAppDesc"`
}

func NewCreateApiAppRequest added in v1.0.209

func NewCreateApiAppRequest() (request *CreateApiAppRequest)

func (*CreateApiAppRequest) FromJsonString added in v1.0.209

func (r *CreateApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiAppRequest) ToJsonString added in v1.0.209

func (r *CreateApiAppRequest) ToJsonString() string

type CreateApiAppRequestParams added in v1.0.426

type CreateApiAppRequestParams struct {
	// 用户自定义应用名称。
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 应用描述
	ApiAppDesc *string `json:"ApiAppDesc,omitnil,omitempty" name:"ApiAppDesc"`
}

Predefined struct for user

type CreateApiAppResponse added in v1.0.209

type CreateApiAppResponse struct {
	*tchttp.BaseResponse
	Response *CreateApiAppResponseParams `json:"Response"`
}

func NewCreateApiAppResponse added in v1.0.209

func NewCreateApiAppResponse() (response *CreateApiAppResponse)

func (*CreateApiAppResponse) FromJsonString added in v1.0.209

func (r *CreateApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiAppResponse) ToJsonString added in v1.0.209

func (r *CreateApiAppResponse) ToJsonString() string

type CreateApiAppResponseParams added in v1.0.426

type CreateApiAppResponseParams struct {
	// 新增的应用详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiAppInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateApiKeyRequest

type CreateApiKeyRequest struct {
	*tchttp.BaseRequest

	// 用户自定义密钥名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥类型,支持 auto 和 manual(自定义密钥),默认为 auto。
	AccessKeyType *string `json:"AccessKeyType,omitnil,omitempty" name:"AccessKeyType"`

	// 用户自定义密钥 ID,AccessKeyType 为 manual 时必传。长度为5 - 50字符,由字母、数字、英文下划线组成。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 用户自定义密钥 Key,AccessKeyType 为 manual 时必传。长度为10 - 50字符,由字母、数字、英文下划线。
	AccessKeySecret *string `json:"AccessKeySecret,omitnil,omitempty" name:"AccessKeySecret"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreateApiKeyRequest

func NewCreateApiKeyRequest() (request *CreateApiKeyRequest)

func (*CreateApiKeyRequest) FromJsonString

func (r *CreateApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiKeyRequest) ToJsonString

func (r *CreateApiKeyRequest) ToJsonString() string

type CreateApiKeyRequestParams added in v1.0.426

type CreateApiKeyRequestParams struct {
	// 用户自定义密钥名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥类型,支持 auto 和 manual(自定义密钥),默认为 auto。
	AccessKeyType *string `json:"AccessKeyType,omitnil,omitempty" name:"AccessKeyType"`

	// 用户自定义密钥 ID,AccessKeyType 为 manual 时必传。长度为5 - 50字符,由字母、数字、英文下划线组成。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 用户自定义密钥 Key,AccessKeyType 为 manual 时必传。长度为10 - 50字符,由字母、数字、英文下划线。
	AccessKeySecret *string `json:"AccessKeySecret,omitnil,omitempty" name:"AccessKeySecret"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateApiKeyResponse

type CreateApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *CreateApiKeyResponseParams `json:"Response"`
}

func NewCreateApiKeyResponse

func NewCreateApiKeyResponse() (response *CreateApiKeyResponse)

func (*CreateApiKeyResponse) FromJsonString

func (r *CreateApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiKeyResponse) ToJsonString

func (r *CreateApiKeyResponse) ToJsonString() string

type CreateApiKeyResponseParams added in v1.0.426

type CreateApiKeyResponseParams struct {
	// 新增的密钥详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiKey `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateApiRequest

type CreateApiRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、EB、TARGET、VPC、UPSTREAM、GRPC、COS、WEBSOCKET。
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// API 的后端服务超时时间,单位是秒。
	ServiceTimeout *int64 `json:"ServiceTimeout,omitnil,omitempty" name:"ServiceTimeout"`

	// API 的前端请求协议,支持HTTP和WEBSOCKET。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 请求的前端配置。
	RequestConfig *ApiRequestConfig `json:"RequestConfig,omitnil,omitempty" name:"RequestConfig"`

	// 用户自定义的 API 名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 用户自定义的 API 接口描述。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// API 类型,支持NORMAL(普通API)和TSF(微服务API),默认为NORMAL。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 鉴权类型。支持SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、APP(应用认证)。默认为NONE。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// 是否开启跨域。
	EnableCORS *bool `json:"EnableCORS,omitnil,omitempty" name:"EnableCORS"`

	// 常量参数。
	ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitnil,omitempty" name:"ConstantParameters"`

	// 前端请求参数。
	RequestParameters []*RequestParameter `json:"RequestParameters,omitnil,omitempty" name:"RequestParameters"`

	// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
	ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitnil,omitempty" name:"ServiceMockReturnMessage"`

	// API绑定微服务列表。
	MicroServices []*MicroServiceReq `json:"MicroServices,omitnil,omitempty" name:"MicroServices"`

	// 微服务的负载均衡配置。
	ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitnil,omitempty" name:"ServiceTsfLoadBalanceConf"`

	// 微服务的健康检查配置。
	ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitnil,omitempty" name:"ServiceTsfHealthCheckConf"`

	// target类型后端资源信息。(内测阶段)
	TargetServices []*TargetServicesReq `json:"TargetServices,omitnil,omitempty" name:"TargetServices"`

	// target类型负载均衡配置。(内测阶段)
	TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitnil,omitempty" name:"TargetServicesLoadBalanceConf"`

	// target健康检查配置。(内测阶段)
	TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitnil,omitempty" name:"TargetServicesHealthCheckConf"`

	// scf 函数名称。当后端类型是SCF时生效。
	ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitnil,omitempty" name:"ServiceScfFunctionName"`

	// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionName"`

	// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionName"`

	// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionName"`

	// scf 函数命名空间。当后端类型是SCF时生效。
	ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitnil,omitempty" name:"ServiceScfFunctionNamespace"`

	// scf函数版本。当后端类型是SCF时生效。
	ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitnil,omitempty" name:"ServiceScfFunctionQualifier"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`

	// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`

	// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`

	// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`

	// 是否开启响应集成。当后端类型是SCF时生效。
	ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitnil,omitempty" name:"ServiceScfIsIntegratedResponse"`

	// 开始调试后计费。(云市场预留字段)
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
	IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitnil,omitempty" name:"IsDeleteResponseErrorCodes"`

	// 返回类型。
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// 自定义响应配置成功响应示例。
	ResponseSuccessExample *string `json:"ResponseSuccessExample,omitnil,omitempty" name:"ResponseSuccessExample"`

	// 自定义响应配置失败响应示例。
	ResponseFailExample *string `json:"ResponseFailExample,omitnil,omitempty" name:"ResponseFailExample"`

	// API 的后端服务配置。
	ServiceConfig *ServiceConfig `json:"ServiceConfig,omitnil,omitempty" name:"ServiceConfig"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// API的后端服务参数。
	ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitnil,omitempty" name:"ServiceParameters"`

	// oauth配置。当AuthType是OAUTH时生效。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 用户自定义错误码配置。
	ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitnil,omitempty" name:"ResponseErrorCodes"`

	// tsf serverless 命名空间ID。(内测中)
	TargetNamespaceId *string `json:"TargetNamespaceId,omitnil,omitempty" name:"TargetNamespaceId"`

	// 用户类型。
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`

	// 是否打开Base64编码,只有后端是scf时才会生效。
	IsBase64Encoded *bool `json:"IsBase64Encoded,omitnil,omitempty" name:"IsBase64Encoded"`

	// 事件总线ID。
	EventBusId *string `json:"EventBusId,omitnil,omitempty" name:"EventBusId"`

	// scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
	ServiceScfFunctionType *string `json:"ServiceScfFunctionType,omitnil,omitempty" name:"ServiceScfFunctionType"`

	// 是否开启SCF Event异步调用。
	ServiceScfEventIsAsyncCall *bool `json:"ServiceScfEventIsAsyncCall,omitnil,omitempty" name:"ServiceScfEventIsAsyncCall"`

	// EIAM应用类型。
	EIAMAppType *string `json:"EIAMAppType,omitnil,omitempty" name:"EIAMAppType"`

	// EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
	EIAMAuthType *string `json:"EIAMAuthType,omitnil,omitempty" name:"EIAMAuthType"`

	// EIAM应用Token 有效时间,单位为秒,默认为7200秒。
	TokenTimeout *int64 `json:"TokenTimeout,omitnil,omitempty" name:"TokenTimeout"`

	// EIAM应用ID。
	EIAMAppId *string `json:"EIAMAppId,omitnil,omitempty" name:"EIAMAppId"`

	// 资源的Owner
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

func NewCreateApiRequest

func NewCreateApiRequest() (request *CreateApiRequest)

func (*CreateApiRequest) FromJsonString

func (r *CreateApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiRequest) ToJsonString

func (r *CreateApiRequest) ToJsonString() string

type CreateApiRequestParams added in v1.0.426

type CreateApiRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、EB、TARGET、VPC、UPSTREAM、GRPC、COS、WEBSOCKET。
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// API 的后端服务超时时间,单位是秒。
	ServiceTimeout *int64 `json:"ServiceTimeout,omitnil,omitempty" name:"ServiceTimeout"`

	// API 的前端请求协议,支持HTTP和WEBSOCKET。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 请求的前端配置。
	RequestConfig *ApiRequestConfig `json:"RequestConfig,omitnil,omitempty" name:"RequestConfig"`

	// 用户自定义的 API 名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 用户自定义的 API 接口描述。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// API 类型,支持NORMAL(普通API)和TSF(微服务API),默认为NORMAL。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 鉴权类型。支持SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、APP(应用认证)。默认为NONE。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// 是否开启跨域。
	EnableCORS *bool `json:"EnableCORS,omitnil,omitempty" name:"EnableCORS"`

	// 常量参数。
	ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitnil,omitempty" name:"ConstantParameters"`

	// 前端请求参数。
	RequestParameters []*RequestParameter `json:"RequestParameters,omitnil,omitempty" name:"RequestParameters"`

	// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
	ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitnil,omitempty" name:"ServiceMockReturnMessage"`

	// API绑定微服务列表。
	MicroServices []*MicroServiceReq `json:"MicroServices,omitnil,omitempty" name:"MicroServices"`

	// 微服务的负载均衡配置。
	ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitnil,omitempty" name:"ServiceTsfLoadBalanceConf"`

	// 微服务的健康检查配置。
	ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitnil,omitempty" name:"ServiceTsfHealthCheckConf"`

	// target类型后端资源信息。(内测阶段)
	TargetServices []*TargetServicesReq `json:"TargetServices,omitnil,omitempty" name:"TargetServices"`

	// target类型负载均衡配置。(内测阶段)
	TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitnil,omitempty" name:"TargetServicesLoadBalanceConf"`

	// target健康检查配置。(内测阶段)
	TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitnil,omitempty" name:"TargetServicesHealthCheckConf"`

	// scf 函数名称。当后端类型是SCF时生效。
	ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitnil,omitempty" name:"ServiceScfFunctionName"`

	// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionName"`

	// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionName"`

	// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionName"`

	// scf 函数命名空间。当后端类型是SCF时生效。
	ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitnil,omitempty" name:"ServiceScfFunctionNamespace"`

	// scf函数版本。当后端类型是SCF时生效。
	ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitnil,omitempty" name:"ServiceScfFunctionQualifier"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`

	// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`

	// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`

	// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`

	// 是否开启响应集成。当后端类型是SCF时生效。
	ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitnil,omitempty" name:"ServiceScfIsIntegratedResponse"`

	// 开始调试后计费。(云市场预留字段)
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
	IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitnil,omitempty" name:"IsDeleteResponseErrorCodes"`

	// 返回类型。
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// 自定义响应配置成功响应示例。
	ResponseSuccessExample *string `json:"ResponseSuccessExample,omitnil,omitempty" name:"ResponseSuccessExample"`

	// 自定义响应配置失败响应示例。
	ResponseFailExample *string `json:"ResponseFailExample,omitnil,omitempty" name:"ResponseFailExample"`

	// API 的后端服务配置。
	ServiceConfig *ServiceConfig `json:"ServiceConfig,omitnil,omitempty" name:"ServiceConfig"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// API的后端服务参数。
	ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitnil,omitempty" name:"ServiceParameters"`

	// oauth配置。当AuthType是OAUTH时生效。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 用户自定义错误码配置。
	ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitnil,omitempty" name:"ResponseErrorCodes"`

	// tsf serverless 命名空间ID。(内测中)
	TargetNamespaceId *string `json:"TargetNamespaceId,omitnil,omitempty" name:"TargetNamespaceId"`

	// 用户类型。
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`

	// 是否打开Base64编码,只有后端是scf时才会生效。
	IsBase64Encoded *bool `json:"IsBase64Encoded,omitnil,omitempty" name:"IsBase64Encoded"`

	// 事件总线ID。
	EventBusId *string `json:"EventBusId,omitnil,omitempty" name:"EventBusId"`

	// scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
	ServiceScfFunctionType *string `json:"ServiceScfFunctionType,omitnil,omitempty" name:"ServiceScfFunctionType"`

	// 是否开启SCF Event异步调用。
	ServiceScfEventIsAsyncCall *bool `json:"ServiceScfEventIsAsyncCall,omitnil,omitempty" name:"ServiceScfEventIsAsyncCall"`

	// EIAM应用类型。
	EIAMAppType *string `json:"EIAMAppType,omitnil,omitempty" name:"EIAMAppType"`

	// EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
	EIAMAuthType *string `json:"EIAMAuthType,omitnil,omitempty" name:"EIAMAuthType"`

	// EIAM应用Token 有效时间,单位为秒,默认为7200秒。
	TokenTimeout *int64 `json:"TokenTimeout,omitnil,omitempty" name:"TokenTimeout"`

	// EIAM应用ID。
	EIAMAppId *string `json:"EIAMAppId,omitnil,omitempty" name:"EIAMAppId"`

	// 资源的Owner
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`
}

Predefined struct for user

type CreateApiResponse

type CreateApiResponse struct {
	*tchttp.BaseResponse
	Response *CreateApiResponseParams `json:"Response"`
}

func NewCreateApiResponse

func NewCreateApiResponse() (response *CreateApiResponse)

func (*CreateApiResponse) FromJsonString

func (r *CreateApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateApiResponse) ToJsonString

func (r *CreateApiResponse) ToJsonString() string

type CreateApiResponseParams added in v1.0.426

type CreateApiResponseParams struct {
	// api信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *CreateApiResultInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateApiResultInfo added in v1.0.672

type CreateApiResultInfo struct {
	// api id
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 路径
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// 请求方法
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 创建时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`
}

type CreateApiRsp

type CreateApiRsp struct {
	// api id
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 路径
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// 请求方法
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 创建时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 导入状态
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 异常信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	ErrMsg *string `json:"ErrMsg,omitnil,omitempty" name:"ErrMsg"`

	// api name
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`
}

type CreateApiRspSet added in v1.0.482

type CreateApiRspSet struct {
	// 个数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 返回的数组
	ApiSet []*CreateApiRsp `json:"ApiSet,omitnil,omitempty" name:"ApiSet"`
}

type CreateIPStrategyRequest

type CreateIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 用户自定义的策略名称。
	StrategyName *string `json:"StrategyName,omitnil,omitempty" name:"StrategyName"`

	// 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
	StrategyType *string `json:"StrategyType,omitnil,omitempty" name:"StrategyType"`

	// 策略详情,多个ip 使用\n 分隔符分开。
	StrategyData *string `json:"StrategyData,omitnil,omitempty" name:"StrategyData"`
}

func NewCreateIPStrategyRequest

func NewCreateIPStrategyRequest() (request *CreateIPStrategyRequest)

func (*CreateIPStrategyRequest) FromJsonString

func (r *CreateIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateIPStrategyRequest) ToJsonString

func (r *CreateIPStrategyRequest) ToJsonString() string

type CreateIPStrategyRequestParams added in v1.0.426

type CreateIPStrategyRequestParams struct {
	// 服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 用户自定义的策略名称。
	StrategyName *string `json:"StrategyName,omitnil,omitempty" name:"StrategyName"`

	// 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
	StrategyType *string `json:"StrategyType,omitnil,omitempty" name:"StrategyType"`

	// 策略详情,多个ip 使用\n 分隔符分开。
	StrategyData *string `json:"StrategyData,omitnil,omitempty" name:"StrategyData"`
}

Predefined struct for user

type CreateIPStrategyResponse

type CreateIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *CreateIPStrategyResponseParams `json:"Response"`
}

func NewCreateIPStrategyResponse

func NewCreateIPStrategyResponse() (response *CreateIPStrategyResponse)

func (*CreateIPStrategyResponse) FromJsonString

func (r *CreateIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateIPStrategyResponse) ToJsonString

func (r *CreateIPStrategyResponse) ToJsonString() string

type CreateIPStrategyResponseParams added in v1.0.426

type CreateIPStrategyResponseParams struct {
	// 新建的IP策略详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *IPStrategy `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreatePluginRequest added in v1.0.203

type CreatePluginRequest struct {
	*tchttp.BaseRequest

	// 用户自定义的插件名称。最长50个字符,最短2个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth,Routing,TrafficControlByParameter, CircuitBreaker, ProxyCache。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 插件定义语句,支持json。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`

	// 插件描述,限定200字以内。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreatePluginRequest added in v1.0.203

func NewCreatePluginRequest() (request *CreatePluginRequest)

func (*CreatePluginRequest) FromJsonString added in v1.0.203

func (r *CreatePluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePluginRequest) ToJsonString added in v1.0.203

func (r *CreatePluginRequest) ToJsonString() string

type CreatePluginRequestParams added in v1.0.426

type CreatePluginRequestParams struct {
	// 用户自定义的插件名称。最长50个字符,最短2个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth,Routing,TrafficControlByParameter, CircuitBreaker, ProxyCache。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 插件定义语句,支持json。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`

	// 插件描述,限定200字以内。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreatePluginResponse added in v1.0.203

type CreatePluginResponse struct {
	*tchttp.BaseResponse
	Response *CreatePluginResponseParams `json:"Response"`
}

func NewCreatePluginResponse added in v1.0.203

func NewCreatePluginResponse() (response *CreatePluginResponse)

func (*CreatePluginResponse) FromJsonString added in v1.0.203

func (r *CreatePluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePluginResponse) ToJsonString added in v1.0.203

func (r *CreatePluginResponse) ToJsonString() string

type CreatePluginResponseParams added in v1.0.426

type CreatePluginResponseParams struct {
	// 新建的插件详情。
	Result *Plugin `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateServiceRequest

type CreateServiceRequest struct {
	*tchttp.BaseRequest

	// 用户自定义的服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 服务的前端请求类型。如 http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 用户自定义的服务描述。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// IP版本号,仅支持IPv4。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 集群名称。保留字段,tsf serverless类型使用。
	SetServerName *string `json:"SetServerName,omitnil,omitempty" name:"SetServerName"`

	// 用户类型。保留类型,serverless用户使用。
	AppIdType *string `json:"AppIdType,omitnil,omitempty" name:"AppIdType"`

	// 标签。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 独享实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// vpc属性,选择VPC后不可修改,为服务选择VPC后,可对接该VPC下的后端资源
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`
}

func NewCreateServiceRequest

func NewCreateServiceRequest() (request *CreateServiceRequest)

func (*CreateServiceRequest) FromJsonString

func (r *CreateServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateServiceRequest) ToJsonString

func (r *CreateServiceRequest) ToJsonString() string

type CreateServiceRequestParams added in v1.0.426

type CreateServiceRequestParams struct {
	// 用户自定义的服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 服务的前端请求类型。如 http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 用户自定义的服务描述。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// IP版本号,仅支持IPv4。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 集群名称。保留字段,tsf serverless类型使用。
	SetServerName *string `json:"SetServerName,omitnil,omitempty" name:"SetServerName"`

	// 用户类型。保留类型,serverless用户使用。
	AppIdType *string `json:"AppIdType,omitnil,omitempty" name:"AppIdType"`

	// 标签。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 独享实例id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// vpc属性,选择VPC后不可修改,为服务选择VPC后,可对接该VPC下的后端资源
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`
}

Predefined struct for user

type CreateServiceResponse

type CreateServiceResponse struct {
	*tchttp.BaseResponse
	Response *CreateServiceResponseParams `json:"Response"`
}

func NewCreateServiceResponse

func NewCreateServiceResponse() (response *CreateServiceResponse)

func (*CreateServiceResponse) FromJsonString

func (r *CreateServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateServiceResponse) ToJsonString

func (r *CreateServiceResponse) ToJsonString() string

type CreateServiceResponseParams added in v1.0.426

type CreateServiceResponseParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 用户自定义服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 用户自定义服务描述。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 外网默认域名。
	OuterSubDomain *string `json:"OuterSubDomain,omitnil,omitempty" name:"OuterSubDomain"`

	// vpc内网默认域名。
	InnerSubDomain *string `json:"InnerSubDomain,omitnil,omitempty" name:"InnerSubDomain"`

	// 服务创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 网络类型列表,INNER为内网访问,OUTER为外网访问。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// IP版本号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateUpstreamRequest added in v1.0.357

type CreateUpstreamRequest struct {
	*tchttp.BaseRequest

	// 后端协议,取值范围:HTTP, HTTPS,gRPC,gRPCs
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 负载均衡算法,取值范围:ROUND-ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端访问类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// 请求重试次数,默认3次
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 网关转发到后端的Host请求头
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`

	// 后端节点
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 健康检查配置,目前只支持VPC通道
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// K8S容器服务的配置
	K8sService []*K8sService `json:"K8sService,omitnil,omitempty" name:"K8sService"`
}

func NewCreateUpstreamRequest added in v1.0.357

func NewCreateUpstreamRequest() (request *CreateUpstreamRequest)

func (*CreateUpstreamRequest) FromJsonString added in v1.0.357

func (r *CreateUpstreamRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUpstreamRequest) ToJsonString added in v1.0.357

func (r *CreateUpstreamRequest) ToJsonString() string

type CreateUpstreamRequestParams added in v1.0.426

type CreateUpstreamRequestParams struct {
	// 后端协议,取值范围:HTTP, HTTPS,gRPC,gRPCs
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 负载均衡算法,取值范围:ROUND-ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端访问类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// 请求重试次数,默认3次
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 网关转发到后端的Host请求头
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`

	// 后端节点
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 健康检查配置,目前只支持VPC通道
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// K8S容器服务的配置
	K8sService []*K8sService `json:"K8sService,omitnil,omitempty" name:"K8sService"`
}

Predefined struct for user

type CreateUpstreamResponse added in v1.0.357

type CreateUpstreamResponse struct {
	*tchttp.BaseResponse
	Response *CreateUpstreamResponseParams `json:"Response"`
}

func NewCreateUpstreamResponse added in v1.0.357

func NewCreateUpstreamResponse() (response *CreateUpstreamResponse)

func (*CreateUpstreamResponse) FromJsonString added in v1.0.357

func (r *CreateUpstreamResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUpstreamResponse) ToJsonString added in v1.0.357

func (r *CreateUpstreamResponse) ToJsonString() string

type CreateUpstreamResponseParams added in v1.0.426

type CreateUpstreamResponseParams struct {
	// 创建返回的唯一ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateUsagePlanRequest

type CreateUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 用户自定义的使用计划名称。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 用户自定义的使用计划描述。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreateUsagePlanRequest

func NewCreateUsagePlanRequest() (request *CreateUsagePlanRequest)

func (*CreateUsagePlanRequest) FromJsonString

func (r *CreateUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUsagePlanRequest) ToJsonString

func (r *CreateUsagePlanRequest) ToJsonString() string

type CreateUsagePlanRequestParams added in v1.0.426

type CreateUsagePlanRequestParams struct {
	// 用户自定义的使用计划名称。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 用户自定义的使用计划描述。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 标签
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateUsagePlanResponse

type CreateUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *CreateUsagePlanResponseParams `json:"Response"`
}

func NewCreateUsagePlanResponse

func NewCreateUsagePlanResponse() (response *CreateUsagePlanResponse)

func (*CreateUsagePlanResponse) FromJsonString

func (r *CreateUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUsagePlanResponse) ToJsonString

func (r *CreateUsagePlanResponse) ToJsonString() string

type CreateUsagePlanResponseParams added in v1.0.426

type CreateUsagePlanResponseParams struct {
	// 使用计划详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlanInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteAPIDocRequest

type DeleteAPIDocRequest struct {
	*tchttp.BaseRequest

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

func NewDeleteAPIDocRequest

func NewDeleteAPIDocRequest() (request *DeleteAPIDocRequest)

func (*DeleteAPIDocRequest) FromJsonString

func (r *DeleteAPIDocRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAPIDocRequest) ToJsonString

func (r *DeleteAPIDocRequest) ToJsonString() string

type DeleteAPIDocRequestParams added in v1.0.426

type DeleteAPIDocRequestParams struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

Predefined struct for user

type DeleteAPIDocResponse

type DeleteAPIDocResponse struct {
	*tchttp.BaseResponse
	Response *DeleteAPIDocResponseParams `json:"Response"`
}

func NewDeleteAPIDocResponse

func NewDeleteAPIDocResponse() (response *DeleteAPIDocResponse)

func (*DeleteAPIDocResponse) FromJsonString

func (r *DeleteAPIDocResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAPIDocResponse) ToJsonString

func (r *DeleteAPIDocResponse) ToJsonString() string

type DeleteAPIDocResponseParams added in v1.0.426

type DeleteAPIDocResponseParams struct {
	// 操作是否成功
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteApiAppRequest added in v1.0.209

type DeleteApiAppRequest struct {
	*tchttp.BaseRequest

	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`
}

func NewDeleteApiAppRequest added in v1.0.209

func NewDeleteApiAppRequest() (request *DeleteApiAppRequest)

func (*DeleteApiAppRequest) FromJsonString added in v1.0.209

func (r *DeleteApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiAppRequest) ToJsonString added in v1.0.209

func (r *DeleteApiAppRequest) ToJsonString() string

type DeleteApiAppRequestParams added in v1.0.426

type DeleteApiAppRequestParams struct {
	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`
}

Predefined struct for user

type DeleteApiAppResponse added in v1.0.209

type DeleteApiAppResponse struct {
	*tchttp.BaseResponse
	Response *DeleteApiAppResponseParams `json:"Response"`
}

func NewDeleteApiAppResponse added in v1.0.209

func NewDeleteApiAppResponse() (response *DeleteApiAppResponse)

func (*DeleteApiAppResponse) FromJsonString added in v1.0.209

func (r *DeleteApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiAppResponse) ToJsonString added in v1.0.209

func (r *DeleteApiAppResponse) ToJsonString() string

type DeleteApiAppResponseParams added in v1.0.426

type DeleteApiAppResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteApiKeyRequest

type DeleteApiKeyRequest struct {
	*tchttp.BaseRequest

	// 待删除的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

func NewDeleteApiKeyRequest

func NewDeleteApiKeyRequest() (request *DeleteApiKeyRequest)

func (*DeleteApiKeyRequest) FromJsonString

func (r *DeleteApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiKeyRequest) ToJsonString

func (r *DeleteApiKeyRequest) ToJsonString() string

type DeleteApiKeyRequestParams added in v1.0.426

type DeleteApiKeyRequestParams struct {
	// 待删除的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

Predefined struct for user

type DeleteApiKeyResponse

type DeleteApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *DeleteApiKeyResponseParams `json:"Response"`
}

func NewDeleteApiKeyResponse

func NewDeleteApiKeyResponse() (response *DeleteApiKeyResponse)

func (*DeleteApiKeyResponse) FromJsonString

func (r *DeleteApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiKeyResponse) ToJsonString

func (r *DeleteApiKeyResponse) ToJsonString() string

type DeleteApiKeyResponseParams added in v1.0.426

type DeleteApiKeyResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteApiRequest

type DeleteApiRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

func NewDeleteApiRequest

func NewDeleteApiRequest() (request *DeleteApiRequest)

func (*DeleteApiRequest) FromJsonString

func (r *DeleteApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiRequest) ToJsonString

func (r *DeleteApiRequest) ToJsonString() string

type DeleteApiRequestParams added in v1.0.426

type DeleteApiRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

Predefined struct for user

type DeleteApiResponse

type DeleteApiResponse struct {
	*tchttp.BaseResponse
	Response *DeleteApiResponseParams `json:"Response"`
}

func NewDeleteApiResponse

func NewDeleteApiResponse() (response *DeleteApiResponse)

func (*DeleteApiResponse) FromJsonString

func (r *DeleteApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteApiResponse) ToJsonString

func (r *DeleteApiResponse) ToJsonString() string

type DeleteApiResponseParams added in v1.0.426

type DeleteApiResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteIPStrategyRequest

type DeleteIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 待删除的IP策略所属的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待删除的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`
}

func NewDeleteIPStrategyRequest

func NewDeleteIPStrategyRequest() (request *DeleteIPStrategyRequest)

func (*DeleteIPStrategyRequest) FromJsonString

func (r *DeleteIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteIPStrategyRequest) ToJsonString

func (r *DeleteIPStrategyRequest) ToJsonString() string

type DeleteIPStrategyRequestParams added in v1.0.426

type DeleteIPStrategyRequestParams struct {
	// 待删除的IP策略所属的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待删除的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`
}

Predefined struct for user

type DeleteIPStrategyResponse

type DeleteIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *DeleteIPStrategyResponseParams `json:"Response"`
}

func NewDeleteIPStrategyResponse

func NewDeleteIPStrategyResponse() (response *DeleteIPStrategyResponse)

func (*DeleteIPStrategyResponse) FromJsonString

func (r *DeleteIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteIPStrategyResponse) ToJsonString

func (r *DeleteIPStrategyResponse) ToJsonString() string

type DeleteIPStrategyResponseParams added in v1.0.426

type DeleteIPStrategyResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeletePluginRequest added in v1.0.204

type DeletePluginRequest struct {
	*tchttp.BaseRequest

	// 要删除的API网关插件的ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`
}

func NewDeletePluginRequest added in v1.0.204

func NewDeletePluginRequest() (request *DeletePluginRequest)

func (*DeletePluginRequest) FromJsonString added in v1.0.204

func (r *DeletePluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeletePluginRequest) ToJsonString added in v1.0.204

func (r *DeletePluginRequest) ToJsonString() string

type DeletePluginRequestParams added in v1.0.426

type DeletePluginRequestParams struct {
	// 要删除的API网关插件的ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`
}

Predefined struct for user

type DeletePluginResponse added in v1.0.204

type DeletePluginResponse struct {
	*tchttp.BaseResponse
	Response *DeletePluginResponseParams `json:"Response"`
}

func NewDeletePluginResponse added in v1.0.204

func NewDeletePluginResponse() (response *DeletePluginResponse)

func (*DeletePluginResponse) FromJsonString added in v1.0.204

func (r *DeletePluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeletePluginResponse) ToJsonString added in v1.0.204

func (r *DeletePluginResponse) ToJsonString() string

type DeletePluginResponseParams added in v1.0.426

type DeletePluginResponseParams struct {
	// 删除操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteServiceRequest

type DeleteServiceRequest struct {
	*tchttp.BaseRequest

	// 待删除服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 跳过删除前置条件校验(仅支持独享实例上的服务)
	SkipVerification *int64 `json:"SkipVerification,omitnil,omitempty" name:"SkipVerification"`
}

func NewDeleteServiceRequest

func NewDeleteServiceRequest() (request *DeleteServiceRequest)

func (*DeleteServiceRequest) FromJsonString

func (r *DeleteServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteServiceRequest) ToJsonString

func (r *DeleteServiceRequest) ToJsonString() string

type DeleteServiceRequestParams added in v1.0.426

type DeleteServiceRequestParams struct {
	// 待删除服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 跳过删除前置条件校验(仅支持独享实例上的服务)
	SkipVerification *int64 `json:"SkipVerification,omitnil,omitempty" name:"SkipVerification"`
}

Predefined struct for user

type DeleteServiceResponse

type DeleteServiceResponse struct {
	*tchttp.BaseResponse
	Response *DeleteServiceResponseParams `json:"Response"`
}

func NewDeleteServiceResponse

func NewDeleteServiceResponse() (response *DeleteServiceResponse)

func (*DeleteServiceResponse) FromJsonString

func (r *DeleteServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteServiceResponse) ToJsonString

func (r *DeleteServiceResponse) ToJsonString() string

type DeleteServiceResponseParams added in v1.0.426

type DeleteServiceResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteServiceSubDomainMappingRequest

type DeleteServiceSubDomainMappingRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务绑定的自定义域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 待删除映射的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`
}

func NewDeleteServiceSubDomainMappingRequest

func NewDeleteServiceSubDomainMappingRequest() (request *DeleteServiceSubDomainMappingRequest)

func (*DeleteServiceSubDomainMappingRequest) FromJsonString

func (r *DeleteServiceSubDomainMappingRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteServiceSubDomainMappingRequest) ToJsonString

func (r *DeleteServiceSubDomainMappingRequest) ToJsonString() string

type DeleteServiceSubDomainMappingRequestParams added in v1.0.426

type DeleteServiceSubDomainMappingRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务绑定的自定义域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 待删除映射的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`
}

Predefined struct for user

type DeleteServiceSubDomainMappingResponse

type DeleteServiceSubDomainMappingResponse struct {
	*tchttp.BaseResponse
	Response *DeleteServiceSubDomainMappingResponseParams `json:"Response"`
}

func NewDeleteServiceSubDomainMappingResponse

func NewDeleteServiceSubDomainMappingResponse() (response *DeleteServiceSubDomainMappingResponse)

func (*DeleteServiceSubDomainMappingResponse) FromJsonString

func (r *DeleteServiceSubDomainMappingResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteServiceSubDomainMappingResponse) ToJsonString

type DeleteServiceSubDomainMappingResponseParams added in v1.0.426

type DeleteServiceSubDomainMappingResponseParams struct {
	// 删除自定义域名的路径映射操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteUpstreamRequest added in v1.0.357

type DeleteUpstreamRequest struct {
	*tchttp.BaseRequest

	// 待删除的后端通道ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`
}

func NewDeleteUpstreamRequest added in v1.0.357

func NewDeleteUpstreamRequest() (request *DeleteUpstreamRequest)

func (*DeleteUpstreamRequest) FromJsonString added in v1.0.357

func (r *DeleteUpstreamRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUpstreamRequest) ToJsonString added in v1.0.357

func (r *DeleteUpstreamRequest) ToJsonString() string

type DeleteUpstreamRequestParams added in v1.0.426

type DeleteUpstreamRequestParams struct {
	// 待删除的后端通道ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`
}

Predefined struct for user

type DeleteUpstreamResponse added in v1.0.357

type DeleteUpstreamResponse struct {
	*tchttp.BaseResponse
	Response *DeleteUpstreamResponseParams `json:"Response"`
}

func NewDeleteUpstreamResponse added in v1.0.357

func NewDeleteUpstreamResponse() (response *DeleteUpstreamResponse)

func (*DeleteUpstreamResponse) FromJsonString added in v1.0.357

func (r *DeleteUpstreamResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUpstreamResponse) ToJsonString added in v1.0.357

func (r *DeleteUpstreamResponse) ToJsonString() string

type DeleteUpstreamResponseParams added in v1.0.426

type DeleteUpstreamResponseParams struct {
	// 成功删除的后端通道ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteUsagePlanRequest

type DeleteUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 待删除的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`
}

func NewDeleteUsagePlanRequest

func NewDeleteUsagePlanRequest() (request *DeleteUsagePlanRequest)

func (*DeleteUsagePlanRequest) FromJsonString

func (r *DeleteUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUsagePlanRequest) ToJsonString

func (r *DeleteUsagePlanRequest) ToJsonString() string

type DeleteUsagePlanRequestParams added in v1.0.426

type DeleteUsagePlanRequestParams struct {
	// 待删除的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`
}

Predefined struct for user

type DeleteUsagePlanResponse

type DeleteUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *DeleteUsagePlanResponseParams `json:"Response"`
}

func NewDeleteUsagePlanResponse

func NewDeleteUsagePlanResponse() (response *DeleteUsagePlanResponse)

func (*DeleteUsagePlanResponse) FromJsonString

func (r *DeleteUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUsagePlanResponse) ToJsonString

func (r *DeleteUsagePlanResponse) ToJsonString() string

type DeleteUsagePlanResponseParams added in v1.0.426

type DeleteUsagePlanResponseParams struct {
	// 删除操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DemoteServiceUsagePlanRequest

type DemoteServiceUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 使用计划ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待降级的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`
}

func NewDemoteServiceUsagePlanRequest

func NewDemoteServiceUsagePlanRequest() (request *DemoteServiceUsagePlanRequest)

func (*DemoteServiceUsagePlanRequest) FromJsonString

func (r *DemoteServiceUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DemoteServiceUsagePlanRequest) ToJsonString

func (r *DemoteServiceUsagePlanRequest) ToJsonString() string

type DemoteServiceUsagePlanRequestParams added in v1.0.426

type DemoteServiceUsagePlanRequestParams struct {
	// 使用计划ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待降级的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`
}

Predefined struct for user

type DemoteServiceUsagePlanResponse

type DemoteServiceUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *DemoteServiceUsagePlanResponseParams `json:"Response"`
}

func NewDemoteServiceUsagePlanResponse

func NewDemoteServiceUsagePlanResponse() (response *DemoteServiceUsagePlanResponse)

func (*DemoteServiceUsagePlanResponse) FromJsonString

func (r *DemoteServiceUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DemoteServiceUsagePlanResponse) ToJsonString

func (r *DemoteServiceUsagePlanResponse) ToJsonString() string

type DemoteServiceUsagePlanResponseParams added in v1.0.426

type DemoteServiceUsagePlanResponseParams struct {
	// 降级操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DesApisStatus

type DesApisStatus struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义的 API 接口描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// API 接口的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// VPCID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VpcId *int64 `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// VPC唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// API类型。取值为NORMAL(普通API)和TSF(微服务API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API协议。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 是否买后调试。(云市场预留字段)
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、EIAM。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// OAUTH 配置信息。当AuthType是OAUTH时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 授权API关联的业务API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	//
	// Deprecated: RelationBuniessApiIds is deprecated.
	RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitnil,omitempty" name:"RelationBuniessApiIds"`

	// API关联的标签信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*string `json:"Tags,omitnil,omitempty" name:"Tags"`

	// API 的路径,如 /path。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 的请求方法,如 GET。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`
}

type DescribeAPIDocDetailRequest

type DescribeAPIDocDetailRequest struct {
	*tchttp.BaseRequest

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

func NewDescribeAPIDocDetailRequest

func NewDescribeAPIDocDetailRequest() (request *DescribeAPIDocDetailRequest)

func (*DescribeAPIDocDetailRequest) FromJsonString

func (r *DescribeAPIDocDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAPIDocDetailRequest) ToJsonString

func (r *DescribeAPIDocDetailRequest) ToJsonString() string

type DescribeAPIDocDetailRequestParams added in v1.0.426

type DescribeAPIDocDetailRequestParams struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

Predefined struct for user

type DescribeAPIDocDetailResponse

type DescribeAPIDocDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAPIDocDetailResponseParams `json:"Response"`
}

func NewDescribeAPIDocDetailResponse

func NewDescribeAPIDocDetailResponse() (response *DescribeAPIDocDetailResponse)

func (*DescribeAPIDocDetailResponse) FromJsonString

func (r *DescribeAPIDocDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAPIDocDetailResponse) ToJsonString

func (r *DescribeAPIDocDetailResponse) ToJsonString() string

type DescribeAPIDocDetailResponseParams added in v1.0.426

type DescribeAPIDocDetailResponseParams struct {
	// API文档详细信息
	Result *APIDocInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAPIDocsRequest

type DescribeAPIDocsRequest struct {
	*tchttp.BaseRequest

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeAPIDocsRequest

func NewDescribeAPIDocsRequest() (request *DescribeAPIDocsRequest)

func (*DescribeAPIDocsRequest) FromJsonString

func (r *DescribeAPIDocsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAPIDocsRequest) ToJsonString

func (r *DescribeAPIDocsRequest) ToJsonString() string

type DescribeAPIDocsRequestParams added in v1.0.426

type DescribeAPIDocsRequestParams struct {
	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeAPIDocsResponse

type DescribeAPIDocsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAPIDocsResponseParams `json:"Response"`
}

func NewDescribeAPIDocsResponse

func NewDescribeAPIDocsResponse() (response *DescribeAPIDocsResponse)

func (*DescribeAPIDocsResponse) FromJsonString

func (r *DescribeAPIDocsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAPIDocsResponse) ToJsonString

func (r *DescribeAPIDocsResponse) ToJsonString() string

type DescribeAPIDocsResponseParams added in v1.0.426

type DescribeAPIDocsResponseParams struct {
	// API文档列表信息
	Result *APIDocs `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAllPluginApisRequest added in v1.0.204

type DescribeAllPluginApisRequest struct {
	*tchttp.BaseRequest

	// 要查询的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 环境信息。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeAllPluginApisRequest added in v1.0.204

func NewDescribeAllPluginApisRequest() (request *DescribeAllPluginApisRequest)

func (*DescribeAllPluginApisRequest) FromJsonString added in v1.0.204

func (r *DescribeAllPluginApisRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAllPluginApisRequest) ToJsonString added in v1.0.204

func (r *DescribeAllPluginApisRequest) ToJsonString() string

type DescribeAllPluginApisRequestParams added in v1.0.426

type DescribeAllPluginApisRequestParams struct {
	// 要查询的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 环境信息。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeAllPluginApisResponse added in v1.0.204

type DescribeAllPluginApisResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAllPluginApisResponseParams `json:"Response"`
}

func NewDescribeAllPluginApisResponse added in v1.0.204

func NewDescribeAllPluginApisResponse() (response *DescribeAllPluginApisResponse)

func (*DescribeAllPluginApisResponse) FromJsonString added in v1.0.204

func (r *DescribeAllPluginApisResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAllPluginApisResponse) ToJsonString added in v1.0.204

func (r *DescribeAllPluginApisResponse) ToJsonString() string

type DescribeAllPluginApisResponseParams added in v1.0.426

type DescribeAllPluginApisResponseParams struct {
	// 插件相关API的列表。
	Result *ApiInfoSummary `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiAppBindApisStatusRequest added in v1.0.209

type DescribeApiAppBindApisStatusRequest struct {
	*tchttp.BaseRequest

	// 应用ID
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiId、ApiName、ServiceId、Environment 、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeApiAppBindApisStatusRequest added in v1.0.209

func NewDescribeApiAppBindApisStatusRequest() (request *DescribeApiAppBindApisStatusRequest)

func (*DescribeApiAppBindApisStatusRequest) FromJsonString added in v1.0.209

func (r *DescribeApiAppBindApisStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppBindApisStatusRequest) ToJsonString added in v1.0.209

func (r *DescribeApiAppBindApisStatusRequest) ToJsonString() string

type DescribeApiAppBindApisStatusRequestParams added in v1.0.426

type DescribeApiAppBindApisStatusRequestParams struct {
	// 应用ID
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiId、ApiName、ServiceId、Environment 、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeApiAppBindApisStatusResponse added in v1.0.209

type DescribeApiAppBindApisStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiAppBindApisStatusResponseParams `json:"Response"`
}

func NewDescribeApiAppBindApisStatusResponse added in v1.0.209

func NewDescribeApiAppBindApisStatusResponse() (response *DescribeApiAppBindApisStatusResponse)

func (*DescribeApiAppBindApisStatusResponse) FromJsonString added in v1.0.209

func (r *DescribeApiAppBindApisStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppBindApisStatusResponse) ToJsonString added in v1.0.209

func (r *DescribeApiAppBindApisStatusResponse) ToJsonString() string

type DescribeApiAppBindApisStatusResponseParams added in v1.0.426

type DescribeApiAppBindApisStatusResponseParams struct {
	// 应用绑定的Api列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiAppApiInfos `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiAppRequest added in v1.0.209

type DescribeApiAppRequest struct {
	*tchttp.BaseRequest

	// 应用ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`
}

func NewDescribeApiAppRequest added in v1.0.209

func NewDescribeApiAppRequest() (request *DescribeApiAppRequest)

func (*DescribeApiAppRequest) FromJsonString added in v1.0.209

func (r *DescribeApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppRequest) ToJsonString added in v1.0.209

func (r *DescribeApiAppRequest) ToJsonString() string

type DescribeApiAppRequestParams added in v1.0.426

type DescribeApiAppRequestParams struct {
	// 应用ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`
}

Predefined struct for user

type DescribeApiAppResponse added in v1.0.209

type DescribeApiAppResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiAppResponseParams `json:"Response"`
}

func NewDescribeApiAppResponse added in v1.0.209

func NewDescribeApiAppResponse() (response *DescribeApiAppResponse)

func (*DescribeApiAppResponse) FromJsonString added in v1.0.209

func (r *DescribeApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppResponse) ToJsonString added in v1.0.209

func (r *DescribeApiAppResponse) ToJsonString() string

type DescribeApiAppResponseParams added in v1.0.426

type DescribeApiAppResponseParams struct {
	// 应用详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiAppInfos `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiAppsStatusRequest added in v1.0.209

type DescribeApiAppsStatusRequest struct {
	*tchttp.BaseRequest

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiAppId、ApiAppName、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeApiAppsStatusRequest added in v1.0.209

func NewDescribeApiAppsStatusRequest() (request *DescribeApiAppsStatusRequest)

func (*DescribeApiAppsStatusRequest) FromJsonString added in v1.0.209

func (r *DescribeApiAppsStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppsStatusRequest) ToJsonString added in v1.0.209

func (r *DescribeApiAppsStatusRequest) ToJsonString() string

type DescribeApiAppsStatusRequestParams added in v1.0.426

type DescribeApiAppsStatusRequestParams struct {
	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiAppId、ApiAppName、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeApiAppsStatusResponse added in v1.0.209

type DescribeApiAppsStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiAppsStatusResponseParams `json:"Response"`
}

func NewDescribeApiAppsStatusResponse added in v1.0.209

func NewDescribeApiAppsStatusResponse() (response *DescribeApiAppsStatusResponse)

func (*DescribeApiAppsStatusResponse) FromJsonString added in v1.0.209

func (r *DescribeApiAppsStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiAppsStatusResponse) ToJsonString added in v1.0.209

func (r *DescribeApiAppsStatusResponse) ToJsonString() string

type DescribeApiAppsStatusResponseParams added in v1.0.426

type DescribeApiAppsStatusResponseParams struct {
	// 应用列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiAppInfos `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiBindApiAppsStatusRequest added in v1.0.209

type DescribeApiBindApiAppsStatusRequest struct {
	*tchttp.BaseRequest

	// 服务ID
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// Api的ID的数组
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiAppId、Environment、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeApiBindApiAppsStatusRequest added in v1.0.209

func NewDescribeApiBindApiAppsStatusRequest() (request *DescribeApiBindApiAppsStatusRequest)

func (*DescribeApiBindApiAppsStatusRequest) FromJsonString added in v1.0.209

func (r *DescribeApiBindApiAppsStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiBindApiAppsStatusRequest) ToJsonString added in v1.0.209

func (r *DescribeApiBindApiAppsStatusRequest) ToJsonString() string

type DescribeApiBindApiAppsStatusRequestParams added in v1.0.426

type DescribeApiBindApiAppsStatusRequestParams struct {
	// 服务ID
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// Api的ID的数组
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ApiAppId、Environment、KeyWord( 可以匹配name或者ID)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeApiBindApiAppsStatusResponse added in v1.0.209

type DescribeApiBindApiAppsStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiBindApiAppsStatusResponseParams `json:"Response"`
}

func NewDescribeApiBindApiAppsStatusResponse added in v1.0.209

func NewDescribeApiBindApiAppsStatusResponse() (response *DescribeApiBindApiAppsStatusResponse)

func (*DescribeApiBindApiAppsStatusResponse) FromJsonString added in v1.0.209

func (r *DescribeApiBindApiAppsStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiBindApiAppsStatusResponse) ToJsonString added in v1.0.209

func (r *DescribeApiBindApiAppsStatusResponse) ToJsonString() string

type DescribeApiBindApiAppsStatusResponseParams added in v1.0.426

type DescribeApiBindApiAppsStatusResponseParams struct {
	// 应用绑定的Api列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiAppApiInfos `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiEnvironmentStrategyRequest

type DescribeApiEnvironmentStrategyRequest struct {
	*tchttp.BaseRequest

	// API所属服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境列表。
	EnvironmentNames []*string `json:"EnvironmentNames,omitnil,omitempty" name:"EnvironmentNames"`

	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeApiEnvironmentStrategyRequest

func NewDescribeApiEnvironmentStrategyRequest() (request *DescribeApiEnvironmentStrategyRequest)

func (*DescribeApiEnvironmentStrategyRequest) FromJsonString

func (r *DescribeApiEnvironmentStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiEnvironmentStrategyRequest) ToJsonString

type DescribeApiEnvironmentStrategyRequestParams added in v1.0.426

type DescribeApiEnvironmentStrategyRequestParams struct {
	// API所属服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境列表。
	EnvironmentNames []*string `json:"EnvironmentNames,omitnil,omitempty" name:"EnvironmentNames"`

	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeApiEnvironmentStrategyResponse

type DescribeApiEnvironmentStrategyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiEnvironmentStrategyResponseParams `json:"Response"`
}

func NewDescribeApiEnvironmentStrategyResponse

func NewDescribeApiEnvironmentStrategyResponse() (response *DescribeApiEnvironmentStrategyResponse)

func (*DescribeApiEnvironmentStrategyResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiEnvironmentStrategyResponse) ToJsonString

type DescribeApiEnvironmentStrategyResponseParams added in v1.0.426

type DescribeApiEnvironmentStrategyResponseParams struct {
	// api绑定策略详情
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiEnvironmentStrategyStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiForApiAppRequest added in v1.0.217

type DescribeApiForApiAppRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// Api所属地域
	ApiRegion *string `json:"ApiRegion,omitnil,omitempty" name:"ApiRegion"`
}

func NewDescribeApiForApiAppRequest added in v1.0.217

func NewDescribeApiForApiAppRequest() (request *DescribeApiForApiAppRequest)

func (*DescribeApiForApiAppRequest) FromJsonString added in v1.0.217

func (r *DescribeApiForApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiForApiAppRequest) ToJsonString added in v1.0.217

func (r *DescribeApiForApiAppRequest) ToJsonString() string

type DescribeApiForApiAppRequestParams added in v1.0.426

type DescribeApiForApiAppRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// Api所属地域
	ApiRegion *string `json:"ApiRegion,omitnil,omitempty" name:"ApiRegion"`
}

Predefined struct for user

type DescribeApiForApiAppResponse added in v1.0.217

type DescribeApiForApiAppResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiForApiAppResponseParams `json:"Response"`
}

func NewDescribeApiForApiAppResponse added in v1.0.217

func NewDescribeApiForApiAppResponse() (response *DescribeApiForApiAppResponse)

func (*DescribeApiForApiAppResponse) FromJsonString added in v1.0.217

func (r *DescribeApiForApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiForApiAppResponse) ToJsonString added in v1.0.217

func (r *DescribeApiForApiAppResponse) ToJsonString() string

type DescribeApiForApiAppResponseParams added in v1.0.426

type DescribeApiForApiAppResponseParams struct {
	// API 详情。
	Result *ApiInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiKeyRequest

type DescribeApiKeyRequest struct {
	*tchttp.BaseRequest

	// API 密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

func NewDescribeApiKeyRequest

func NewDescribeApiKeyRequest() (request *DescribeApiKeyRequest)

func (*DescribeApiKeyRequest) FromJsonString

func (r *DescribeApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiKeyRequest) ToJsonString

func (r *DescribeApiKeyRequest) ToJsonString() string

type DescribeApiKeyRequestParams added in v1.0.426

type DescribeApiKeyRequestParams struct {
	// API 密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

Predefined struct for user

type DescribeApiKeyResponse

type DescribeApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiKeyResponseParams `json:"Response"`
}

func NewDescribeApiKeyResponse

func NewDescribeApiKeyResponse() (response *DescribeApiKeyResponse)

func (*DescribeApiKeyResponse) FromJsonString

func (r *DescribeApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiKeyResponse) ToJsonString

func (r *DescribeApiKeyResponse) ToJsonString() string

type DescribeApiKeyResponseParams added in v1.0.426

type DescribeApiKeyResponseParams struct {
	// 密钥详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiKey `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiKeysStatusRequest

type DescribeApiKeysStatusRequest struct {
	*tchttp.BaseRequest

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持AccessKeyId、AccessKeySecret、SecretName、NotUsagePlanId、Status、KeyWord( 可以匹配name或者path)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeApiKeysStatusRequest

func NewDescribeApiKeysStatusRequest() (request *DescribeApiKeysStatusRequest)

func (*DescribeApiKeysStatusRequest) FromJsonString

func (r *DescribeApiKeysStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiKeysStatusRequest) ToJsonString

func (r *DescribeApiKeysStatusRequest) ToJsonString() string

type DescribeApiKeysStatusRequestParams added in v1.0.426

type DescribeApiKeysStatusRequestParams struct {
	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持AccessKeyId、AccessKeySecret、SecretName、NotUsagePlanId、Status、KeyWord( 可以匹配name或者path)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeApiKeysStatusResponse

type DescribeApiKeysStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiKeysStatusResponseParams `json:"Response"`
}

func NewDescribeApiKeysStatusResponse

func NewDescribeApiKeysStatusResponse() (response *DescribeApiKeysStatusResponse)

func (*DescribeApiKeysStatusResponse) FromJsonString

func (r *DescribeApiKeysStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiKeysStatusResponse) ToJsonString

func (r *DescribeApiKeysStatusResponse) ToJsonString() string

type DescribeApiKeysStatusResponseParams added in v1.0.426

type DescribeApiKeysStatusResponseParams struct {
	// 密钥列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiKeysStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiRequest

type DescribeApiRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

func NewDescribeApiRequest

func NewDescribeApiRequest() (request *DescribeApiRequest)

func (*DescribeApiRequest) FromJsonString

func (r *DescribeApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiRequest) ToJsonString

func (r *DescribeApiRequest) ToJsonString() string

type DescribeApiRequestParams added in v1.0.426

type DescribeApiRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

Predefined struct for user

type DescribeApiResponse

type DescribeApiResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiResponseParams `json:"Response"`
}

func NewDescribeApiResponse

func NewDescribeApiResponse() (response *DescribeApiResponse)

func (*DescribeApiResponse) FromJsonString

func (r *DescribeApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiResponse) ToJsonString

func (r *DescribeApiResponse) ToJsonString() string

type DescribeApiResponseParams added in v1.0.426

type DescribeApiResponseParams struct {
	// API 详情。
	Result *ApiInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApiResultServiceParametersInfo added in v1.0.672

type DescribeApiResultServiceParametersInfo struct {
	// API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// API 的后端服务参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Position *string `json:"Position,omitnil,omitempty" name:"Position"`

	// API 的后端服务参数对应的前端参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterPosition *string `json:"RelevantRequestParameterPosition,omitnil,omitempty" name:"RelevantRequestParameterPosition"`

	// API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterName *string `json:"RelevantRequestParameterName,omitnil,omitempty" name:"RelevantRequestParameterName"`

	// API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterDesc *string `json:"RelevantRequestParameterDesc,omitnil,omitempty" name:"RelevantRequestParameterDesc"`
}

type DescribeApiUsagePlanRequest

type DescribeApiUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeApiUsagePlanRequest

func NewDescribeApiUsagePlanRequest() (request *DescribeApiUsagePlanRequest)

func (*DescribeApiUsagePlanRequest) FromJsonString

func (r *DescribeApiUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiUsagePlanRequest) ToJsonString

func (r *DescribeApiUsagePlanRequest) ToJsonString() string

type DescribeApiUsagePlanRequestParams added in v1.0.426

type DescribeApiUsagePlanRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeApiUsagePlanResponse

type DescribeApiUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApiUsagePlanResponseParams `json:"Response"`
}

func NewDescribeApiUsagePlanResponse

func NewDescribeApiUsagePlanResponse() (response *DescribeApiUsagePlanResponse)

func (*DescribeApiUsagePlanResponse) FromJsonString

func (r *DescribeApiUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApiUsagePlanResponse) ToJsonString

func (r *DescribeApiUsagePlanResponse) ToJsonString() string

type DescribeApiUsagePlanResponseParams added in v1.0.426

type DescribeApiUsagePlanResponseParams struct {
	// api绑定使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiUsagePlanSet `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApisStatusRequest

type DescribeApisStatusRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、 Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys (values 为 tag key的列表),其中NotUsagePlanId和Environment必须同时使用,不能单独使用一个。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeApisStatusRequest

func NewDescribeApisStatusRequest() (request *DescribeApisStatusRequest)

func (*DescribeApisStatusRequest) FromJsonString

func (r *DescribeApisStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApisStatusRequest) ToJsonString

func (r *DescribeApisStatusRequest) ToJsonString() string

type DescribeApisStatusRequestParams added in v1.0.426

type DescribeApisStatusRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回数量,默认为 20,最大值为 100
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、 Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys (values 为 tag key的列表),其中NotUsagePlanId和Environment必须同时使用,不能单独使用一个。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeApisStatusResponse

type DescribeApisStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApisStatusResponseParams `json:"Response"`
}

func NewDescribeApisStatusResponse

func NewDescribeApisStatusResponse() (response *DescribeApisStatusResponse)

func (*DescribeApisStatusResponse) FromJsonString

func (r *DescribeApisStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeApisStatusResponse) ToJsonString

func (r *DescribeApisStatusResponse) ToJsonString() string

type DescribeApisStatusResponseParams added in v1.0.426

type DescribeApisStatusResponseParams struct {
	// API 详情列表。
	Result *DescribeApisStatusResultInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeApisStatusResultApiIdStatusSetInfo added in v1.0.675

type DescribeApisStatusResultApiIdStatusSetInfo struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义的 API 接口描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// API 接口的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// VPCID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VpcId *int64 `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// VPC唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// API类型。取值为NORMAL(普通API)和TSF(微服务API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API协议。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 是否买后调试。(云市场预留字段)
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、EIAM。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// OAUTH 配置信息。当AuthType是OAUTH时生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 授权API关联的业务API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	//
	// Deprecated: RelationBuniessApiIds is deprecated.
	RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitnil,omitempty" name:"RelationBuniessApiIds"`

	// API关联的标签信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*ApigatewayTags `json:"Tags,omitnil,omitempty" name:"Tags"`

	// API 的路径,如 /path。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 的请求方法,如 GET。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`
}

type DescribeApisStatusResultInfo added in v1.0.672

type DescribeApisStatusResultInfo struct {
	// 符合条件的 API 接口数量。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// API 接口列表。
	ApiIdStatusSet []*DescribeApisStatusResultApiIdStatusSetInfo `json:"ApiIdStatusSet,omitnil,omitempty" name:"ApiIdStatusSet"`
}

type DescribeExclusiveInstanceDetailRequest added in v1.0.288

type DescribeExclusiveInstanceDetailRequest struct {
	*tchttp.BaseRequest

	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeExclusiveInstanceDetailRequest added in v1.0.288

func NewDescribeExclusiveInstanceDetailRequest() (request *DescribeExclusiveInstanceDetailRequest)

func (*DescribeExclusiveInstanceDetailRequest) FromJsonString added in v1.0.288

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstanceDetailRequest) ToJsonString added in v1.0.288

type DescribeExclusiveInstanceDetailRequestParams added in v1.0.426

type DescribeExclusiveInstanceDetailRequestParams struct {
	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeExclusiveInstanceDetailResponse added in v1.0.288

type DescribeExclusiveInstanceDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeExclusiveInstanceDetailResponseParams `json:"Response"`
}

func NewDescribeExclusiveInstanceDetailResponse added in v1.0.288

func NewDescribeExclusiveInstanceDetailResponse() (response *DescribeExclusiveInstanceDetailResponse)

func (*DescribeExclusiveInstanceDetailResponse) FromJsonString added in v1.0.288

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstanceDetailResponse) ToJsonString added in v1.0.288

type DescribeExclusiveInstanceDetailResponseParams added in v1.0.426

type DescribeExclusiveInstanceDetailResponseParams struct {
	// 独享实例详情
	Result *InstanceDetail `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeExclusiveInstancesRequest added in v1.0.288

type DescribeExclusiveInstancesRequest struct {
	*tchttp.BaseRequest

	// 分页查询,limit
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询,offset
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeExclusiveInstancesRequest added in v1.0.288

func NewDescribeExclusiveInstancesRequest() (request *DescribeExclusiveInstancesRequest)

func (*DescribeExclusiveInstancesRequest) FromJsonString added in v1.0.288

func (r *DescribeExclusiveInstancesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstancesRequest) ToJsonString added in v1.0.288

func (r *DescribeExclusiveInstancesRequest) ToJsonString() string

type DescribeExclusiveInstancesRequestParams added in v1.0.426

type DescribeExclusiveInstancesRequestParams struct {
	// 分页查询,limit
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询,offset
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeExclusiveInstancesResponse added in v1.0.288

type DescribeExclusiveInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeExclusiveInstancesResponseParams `json:"Response"`
}

func NewDescribeExclusiveInstancesResponse added in v1.0.288

func NewDescribeExclusiveInstancesResponse() (response *DescribeExclusiveInstancesResponse)

func (*DescribeExclusiveInstancesResponse) FromJsonString added in v1.0.288

func (r *DescribeExclusiveInstancesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstancesResponse) ToJsonString added in v1.0.288

func (r *DescribeExclusiveInstancesResponse) ToJsonString() string

type DescribeExclusiveInstancesResponseParams added in v1.0.426

type DescribeExclusiveInstancesResponseParams struct {
	// 独享实例列表查询结果
	Result *DescribeExclusiveInstancesResult `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeExclusiveInstancesResult added in v1.0.672

type DescribeExclusiveInstancesResult struct {
}

type DescribeExclusiveInstancesStatusRequest added in v1.0.419

type DescribeExclusiveInstancesStatusRequest struct {
	*tchttp.BaseRequest

	// 分页查询,limit
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询,offset
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeExclusiveInstancesStatusRequest added in v1.0.419

func NewDescribeExclusiveInstancesStatusRequest() (request *DescribeExclusiveInstancesStatusRequest)

func (*DescribeExclusiveInstancesStatusRequest) FromJsonString added in v1.0.419

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstancesStatusRequest) ToJsonString added in v1.0.419

type DescribeExclusiveInstancesStatusRequestParams added in v1.0.426

type DescribeExclusiveInstancesStatusRequestParams struct {
	// 分页查询,limit
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页查询,offset
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeExclusiveInstancesStatusResponse added in v1.0.419

type DescribeExclusiveInstancesStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeExclusiveInstancesStatusResponseParams `json:"Response"`
}

func NewDescribeExclusiveInstancesStatusResponse added in v1.0.419

func NewDescribeExclusiveInstancesStatusResponse() (response *DescribeExclusiveInstancesStatusResponse)

func (*DescribeExclusiveInstancesStatusResponse) FromJsonString added in v1.0.419

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeExclusiveInstancesStatusResponse) ToJsonString added in v1.0.419

type DescribeExclusiveInstancesStatusResponseParams added in v1.0.426

type DescribeExclusiveInstancesStatusResponseParams struct {
	// 独享实例列表查询结果
	Result *InstanceSummary `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeIPStrategyApisStatusRequest

type DescribeIPStrategyApisStatusRequest struct {
	*tchttp.BaseRequest

	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 策略所在环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持 ApiPath、ApiName、KeyWord(模糊查询Path 和Name)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeIPStrategyApisStatusRequest

func NewDescribeIPStrategyApisStatusRequest() (request *DescribeIPStrategyApisStatusRequest)

func (*DescribeIPStrategyApisStatusRequest) FromJsonString

func (r *DescribeIPStrategyApisStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategyApisStatusRequest) ToJsonString

func (r *DescribeIPStrategyApisStatusRequest) ToJsonString() string

type DescribeIPStrategyApisStatusRequestParams added in v1.0.426

type DescribeIPStrategyApisStatusRequestParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 策略所在环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持 ApiPath、ApiName、KeyWord(模糊查询Path 和Name)。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeIPStrategyApisStatusResponse

type DescribeIPStrategyApisStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIPStrategyApisStatusResponseParams `json:"Response"`
}

func NewDescribeIPStrategyApisStatusResponse

func NewDescribeIPStrategyApisStatusResponse() (response *DescribeIPStrategyApisStatusResponse)

func (*DescribeIPStrategyApisStatusResponse) FromJsonString

func (r *DescribeIPStrategyApisStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategyApisStatusResponse) ToJsonString

func (r *DescribeIPStrategyApisStatusResponse) ToJsonString() string

type DescribeIPStrategyApisStatusResponseParams added in v1.0.426

type DescribeIPStrategyApisStatusResponseParams struct {
	// 环境绑定API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *IPStrategyApiStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeIPStrategyRequest

type DescribeIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// IP 策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 策略关联的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。预留字段,目前不支持过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeIPStrategyRequest

func NewDescribeIPStrategyRequest() (request *DescribeIPStrategyRequest)

func (*DescribeIPStrategyRequest) FromJsonString

func (r *DescribeIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategyRequest) ToJsonString

func (r *DescribeIPStrategyRequest) ToJsonString() string

type DescribeIPStrategyRequestParams added in v1.0.426

type DescribeIPStrategyRequestParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// IP 策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 策略关联的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。预留字段,目前不支持过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeIPStrategyResponse

type DescribeIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIPStrategyResponseParams `json:"Response"`
}

func NewDescribeIPStrategyResponse

func NewDescribeIPStrategyResponse() (response *DescribeIPStrategyResponse)

func (*DescribeIPStrategyResponse) FromJsonString

func (r *DescribeIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategyResponse) ToJsonString

func (r *DescribeIPStrategyResponse) ToJsonString() string

type DescribeIPStrategyResponseParams added in v1.0.426

type DescribeIPStrategyResponseParams struct {
	// IP策略详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *IPStrategy `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeIPStrategysStatusRequest

type DescribeIPStrategysStatusRequest struct {
	*tchttp.BaseRequest

	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 过滤条件。支持StrategyName。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeIPStrategysStatusRequest

func NewDescribeIPStrategysStatusRequest() (request *DescribeIPStrategysStatusRequest)

func (*DescribeIPStrategysStatusRequest) FromJsonString

func (r *DescribeIPStrategysStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategysStatusRequest) ToJsonString

func (r *DescribeIPStrategysStatusRequest) ToJsonString() string

type DescribeIPStrategysStatusRequestParams added in v1.0.426

type DescribeIPStrategysStatusRequestParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 过滤条件。支持StrategyName。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeIPStrategysStatusResponse

type DescribeIPStrategysStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIPStrategysStatusResponseParams `json:"Response"`
}

func NewDescribeIPStrategysStatusResponse

func NewDescribeIPStrategysStatusResponse() (response *DescribeIPStrategysStatusResponse)

func (*DescribeIPStrategysStatusResponse) FromJsonString

func (r *DescribeIPStrategysStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIPStrategysStatusResponse) ToJsonString

func (r *DescribeIPStrategysStatusResponse) ToJsonString() string

type DescribeIPStrategysStatusResponseParams added in v1.0.426

type DescribeIPStrategysStatusResponseParams struct {
	// 符合条件的策略列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *IPStrategiesStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeLogSearchRequest

type DescribeLogSearchRequest struct {
	*tchttp.BaseRequest

	// 日志开始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 日志结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 服务id
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 保留字段
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 单次要返回的日志条数,单次返回的最大条数为100
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据上次返回的ConText,获取后续的内容,最多可获取10000条
	ConText *string `json:"ConText,omitnil,omitempty" name:"ConText"`

	// 按时间排序 asc(升序)或者 desc(降序),默认为 desc
	Sort *string `json:"Sort,omitnil,omitempty" name:"Sort"`

	// 保留字段
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// 检索条件,支持的检索条件如下:
	// req_id:“=”
	// api_id:“=”
	// cip:“=”
	// uip:“:”
	// err_msg:“:”
	// rsp_st:“=” 、“!=” 、 “:” 、 “>” 、 “<”
	// req_t:”>=“ 、 ”<=“
	//
	// 说明:
	// “:”表示包含,“!=”表示不等于,字段含义见输出参数的LogSet说明
	LogQuerys []*LogQuery `json:"LogQuerys,omitnil,omitempty" name:"LogQuerys"`
}

func NewDescribeLogSearchRequest

func NewDescribeLogSearchRequest() (request *DescribeLogSearchRequest)

func (*DescribeLogSearchRequest) FromJsonString

func (r *DescribeLogSearchRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeLogSearchRequest) ToJsonString

func (r *DescribeLogSearchRequest) ToJsonString() string

type DescribeLogSearchRequestParams added in v1.0.426

type DescribeLogSearchRequestParams struct {
	// 日志开始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 日志结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 服务id
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 保留字段
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// 单次要返回的日志条数,单次返回的最大条数为100
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据上次返回的ConText,获取后续的内容,最多可获取10000条
	ConText *string `json:"ConText,omitnil,omitempty" name:"ConText"`

	// 按时间排序 asc(升序)或者 desc(降序),默认为 desc
	Sort *string `json:"Sort,omitnil,omitempty" name:"Sort"`

	// 保留字段
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// 检索条件,支持的检索条件如下:
	// req_id:“=”
	// api_id:“=”
	// cip:“=”
	// uip:“:”
	// err_msg:“:”
	// rsp_st:“=” 、“!=” 、 “:” 、 “>” 、 “<”
	// req_t:”>=“ 、 ”<=“
	//
	// 说明:
	// “:”表示包含,“!=”表示不等于,字段含义见输出参数的LogSet说明
	//
	// Deprecated: LogQuerys is deprecated.
	LogQuerys []*LogQuery `json:"LogQuerys,omitnil,omitempty" name:"LogQuerys"`
}

Predefined struct for user

type DescribeLogSearchResponse

type DescribeLogSearchResponse struct {
	*tchttp.BaseResponse
	Response *DescribeLogSearchResponseParams `json:"Response"`
}

func NewDescribeLogSearchResponse

func NewDescribeLogSearchResponse() (response *DescribeLogSearchResponse)

func (*DescribeLogSearchResponse) FromJsonString

func (r *DescribeLogSearchResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeLogSearchResponse) ToJsonString

func (r *DescribeLogSearchResponse) ToJsonString() string

type DescribeLogSearchResponseParams added in v1.0.426

type DescribeLogSearchResponseParams struct {
	// 获取更多检索结果的游标,值为""表示无后续结果
	ConText *string `json:"ConText,omitnil,omitempty" name:"ConText"`

	// 由0或多条日志组成,每条日志格式如下:
	// '[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]'
	// '[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]'
	// '[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]’
	// '[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local][req_id:$request_id]';
	//
	// 说明:
	// app_id: 用户 ID。
	// env_name:环境名称。
	// service_id: 服务 ID。
	// http_host: 域名。
	// api_id: API 的 ID。
	// uri:请求的路径。
	// scheme: HTTP/HTTPS 协议。
	// rsp_st: 请求响应状态码。
	// ups_st: 后端业务服务器的响应状态码(如果请求透传到后端,改变量不为空。如果请求在 APIGW 就被拦截了,那么该变量显示为 -)。
	// cip: 客户端 IP。
	// uip: 后端业务服务(upstream)的 IP。
	// vip: 请求访问的 VIP。
	// rsp_len: 响应长度。
	// req_len: 请求长度。
	// req_t: 请求响应的总时间。
	// ups_rsp_t: 后端响应的总时间(apigw 建立连接到接收到后端响应的时间)。
	// ups_conn_t: 与后端业务服务器连接建立成功时间。
	// ups_head_t:后端响应的头部到达时间。
	// err_msg: 错误信息。
	// tcp_rtt: 客户端 TCP 连接信息,RTT(Round Trip Time)由三部分组成:链路的传播时间(propagation delay)、末端系统的处理时间、路由器缓存中的排队和处理时间(queuing delay)。
	// req_id:请求id。
	LogSet []*string `json:"LogSet,omitnil,omitempty" name:"LogSet"`

	// 单次搜索返回的日志条数,TotalCount <= Limit
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePluginApisRequest added in v1.0.204

type DescribePluginApisRequest struct {
	*tchttp.BaseRequest

	// 查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribePluginApisRequest added in v1.0.204

func NewDescribePluginApisRequest() (request *DescribePluginApisRequest)

func (*DescribePluginApisRequest) FromJsonString added in v1.0.204

func (r *DescribePluginApisRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginApisRequest) ToJsonString added in v1.0.204

func (r *DescribePluginApisRequest) ToJsonString() string

type DescribePluginApisRequestParams added in v1.0.426

type DescribePluginApisRequestParams struct {
	// 查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribePluginApisResponse added in v1.0.204

type DescribePluginApisResponse struct {
	*tchttp.BaseResponse
	Response *DescribePluginApisResponseParams `json:"Response"`
}

func NewDescribePluginApisResponse added in v1.0.204

func NewDescribePluginApisResponse() (response *DescribePluginApisResponse)

func (*DescribePluginApisResponse) FromJsonString added in v1.0.204

func (r *DescribePluginApisResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginApisResponse) ToJsonString added in v1.0.204

func (r *DescribePluginApisResponse) ToJsonString() string

type DescribePluginApisResponseParams added in v1.0.426

type DescribePluginApisResponseParams struct {
	// 插件绑定的API列表信息。
	Result *AttachedApiSummary `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePluginRequest added in v1.0.204

type DescribePluginRequest struct {
	*tchttp.BaseRequest

	// 要查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribePluginRequest added in v1.0.204

func NewDescribePluginRequest() (request *DescribePluginRequest)

func (*DescribePluginRequest) FromJsonString added in v1.0.204

func (r *DescribePluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginRequest) ToJsonString added in v1.0.204

func (r *DescribePluginRequest) ToJsonString() string

type DescribePluginRequestParams added in v1.0.426

type DescribePluginRequestParams struct {
	// 要查询的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribePluginResponse added in v1.0.204

type DescribePluginResponse struct {
	*tchttp.BaseResponse
	Response *DescribePluginResponseParams `json:"Response"`
}

func NewDescribePluginResponse added in v1.0.204

func NewDescribePluginResponse() (response *DescribePluginResponse)

func (*DescribePluginResponse) FromJsonString added in v1.0.204

func (r *DescribePluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginResponse) ToJsonString added in v1.0.204

func (r *DescribePluginResponse) ToJsonString() string

type DescribePluginResponseParams added in v1.0.426

type DescribePluginResponseParams struct {
	// 插件详情。
	Result *Plugin `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePluginsByApiRequest added in v1.0.533

type DescribePluginsByApiRequest struct {
	*tchttp.BaseRequest

	// 要查询的API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 要查询的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境信息。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribePluginsByApiRequest added in v1.0.533

func NewDescribePluginsByApiRequest() (request *DescribePluginsByApiRequest)

func (*DescribePluginsByApiRequest) FromJsonString added in v1.0.533

func (r *DescribePluginsByApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginsByApiRequest) ToJsonString added in v1.0.533

func (r *DescribePluginsByApiRequest) ToJsonString() string

type DescribePluginsByApiRequestParams added in v1.0.533

type DescribePluginsByApiRequestParams struct {
	// 要查询的API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 要查询的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境信息。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribePluginsByApiResponse added in v1.0.533

type DescribePluginsByApiResponse struct {
	*tchttp.BaseResponse
	Response *DescribePluginsByApiResponseParams `json:"Response"`
}

func NewDescribePluginsByApiResponse added in v1.0.533

func NewDescribePluginsByApiResponse() (response *DescribePluginsByApiResponse)

func (*DescribePluginsByApiResponse) FromJsonString added in v1.0.533

func (r *DescribePluginsByApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginsByApiResponse) ToJsonString added in v1.0.533

func (r *DescribePluginsByApiResponse) ToJsonString() string

type DescribePluginsByApiResponseParams added in v1.0.533

type DescribePluginsByApiResponseParams struct {
	// 插件可绑定的API列表信息。
	Result *AttachedPluginSummary `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePluginsRequest

type DescribePluginsRequest struct {
	*tchttp.BaseRequest

	// 要查询的插件列表。
	PluginIds []*string `json:"PluginIds,omitnil,omitempty" name:"PluginIds"`

	// 要查询的插件名称。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 要查询的插件类型。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。预留字段,目前不支持过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribePluginsRequest

func NewDescribePluginsRequest() (request *DescribePluginsRequest)

func (*DescribePluginsRequest) FromJsonString

func (r *DescribePluginsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginsRequest) ToJsonString

func (r *DescribePluginsRequest) ToJsonString() string

type DescribePluginsRequestParams added in v1.0.426

type DescribePluginsRequestParams struct {
	// 要查询的插件列表。
	PluginIds []*string `json:"PluginIds,omitnil,omitempty" name:"PluginIds"`

	// 要查询的插件名称。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 要查询的插件类型。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。预留字段,目前不支持过滤。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribePluginsResponse

type DescribePluginsResponse struct {
	*tchttp.BaseResponse
	Response *DescribePluginsResponseParams `json:"Response"`
}

func NewDescribePluginsResponse

func NewDescribePluginsResponse() (response *DescribePluginsResponse)

func (*DescribePluginsResponse) FromJsonString

func (r *DescribePluginsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribePluginsResponse) ToJsonString

func (r *DescribePluginsResponse) ToJsonString() string

type DescribePluginsResponseParams added in v1.0.426

type DescribePluginsResponseParams struct {
	// 插件详情。
	Result *PluginSummary `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceEnvironmentListRequest

type DescribeServiceEnvironmentListRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceEnvironmentListRequest

func NewDescribeServiceEnvironmentListRequest() (request *DescribeServiceEnvironmentListRequest)

func (*DescribeServiceEnvironmentListRequest) FromJsonString

func (r *DescribeServiceEnvironmentListRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentListRequest) ToJsonString

type DescribeServiceEnvironmentListRequestParams added in v1.0.426

type DescribeServiceEnvironmentListRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceEnvironmentListResponse

type DescribeServiceEnvironmentListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceEnvironmentListResponseParams `json:"Response"`
}

func NewDescribeServiceEnvironmentListResponse

func NewDescribeServiceEnvironmentListResponse() (response *DescribeServiceEnvironmentListResponse)

func (*DescribeServiceEnvironmentListResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentListResponse) ToJsonString

type DescribeServiceEnvironmentListResponseParams added in v1.0.426

type DescribeServiceEnvironmentListResponseParams struct {
	// 服务绑定环境详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServiceEnvironmentSet `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceEnvironmentReleaseHistoryRequest

type DescribeServiceEnvironmentReleaseHistoryRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceEnvironmentReleaseHistoryRequest

func NewDescribeServiceEnvironmentReleaseHistoryRequest() (request *DescribeServiceEnvironmentReleaseHistoryRequest)

func (*DescribeServiceEnvironmentReleaseHistoryRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentReleaseHistoryRequest) ToJsonString

type DescribeServiceEnvironmentReleaseHistoryRequestParams added in v1.0.426

type DescribeServiceEnvironmentReleaseHistoryRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceEnvironmentReleaseHistoryResponse

type DescribeServiceEnvironmentReleaseHistoryResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceEnvironmentReleaseHistoryResponseParams `json:"Response"`
}

func NewDescribeServiceEnvironmentReleaseHistoryResponse

func NewDescribeServiceEnvironmentReleaseHistoryResponse() (response *DescribeServiceEnvironmentReleaseHistoryResponse)

func (*DescribeServiceEnvironmentReleaseHistoryResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentReleaseHistoryResponse) ToJsonString

type DescribeServiceEnvironmentReleaseHistoryResponseParams added in v1.0.426

type DescribeServiceEnvironmentReleaseHistoryResponseParams struct {
	// 服务发布历史。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServiceReleaseHistory `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceEnvironmentStrategyRequest

type DescribeServiceEnvironmentStrategyRequest struct {
	*tchttp.BaseRequest

	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceEnvironmentStrategyRequest

func NewDescribeServiceEnvironmentStrategyRequest() (request *DescribeServiceEnvironmentStrategyRequest)

func (*DescribeServiceEnvironmentStrategyRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentStrategyRequest) ToJsonString

type DescribeServiceEnvironmentStrategyRequestParams added in v1.0.426

type DescribeServiceEnvironmentStrategyRequestParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceEnvironmentStrategyResponse

type DescribeServiceEnvironmentStrategyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceEnvironmentStrategyResponseParams `json:"Response"`
}

func NewDescribeServiceEnvironmentStrategyResponse

func NewDescribeServiceEnvironmentStrategyResponse() (response *DescribeServiceEnvironmentStrategyResponse)

func (*DescribeServiceEnvironmentStrategyResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceEnvironmentStrategyResponse) ToJsonString

type DescribeServiceEnvironmentStrategyResponseParams added in v1.0.426

type DescribeServiceEnvironmentStrategyResponseParams struct {
	// 限流策略列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServiceEnvironmentStrategyStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceForApiAppRequest added in v1.0.209

type DescribeServiceForApiAppRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务所属的地域
	ApiRegion *string `json:"ApiRegion,omitnil,omitempty" name:"ApiRegion"`
}

func NewDescribeServiceForApiAppRequest added in v1.0.209

func NewDescribeServiceForApiAppRequest() (request *DescribeServiceForApiAppRequest)

func (*DescribeServiceForApiAppRequest) FromJsonString added in v1.0.209

func (r *DescribeServiceForApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceForApiAppRequest) ToJsonString added in v1.0.209

func (r *DescribeServiceForApiAppRequest) ToJsonString() string

type DescribeServiceForApiAppRequestParams added in v1.0.426

type DescribeServiceForApiAppRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务所属的地域
	ApiRegion *string `json:"ApiRegion,omitnil,omitempty" name:"ApiRegion"`
}

Predefined struct for user

type DescribeServiceForApiAppResponse added in v1.0.209

type DescribeServiceForApiAppResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceForApiAppResponseParams `json:"Response"`
}

func NewDescribeServiceForApiAppResponse added in v1.0.209

func NewDescribeServiceForApiAppResponse() (response *DescribeServiceForApiAppResponse)

func (*DescribeServiceForApiAppResponse) FromJsonString added in v1.0.209

func (r *DescribeServiceForApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceForApiAppResponse) ToJsonString added in v1.0.209

func (r *DescribeServiceForApiAppResponse) ToJsonString() string

type DescribeServiceForApiAppResponseParams added in v1.0.426

type DescribeServiceForApiAppResponseParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务 环境列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AvailableEnvironments []*string `json:"AvailableEnvironments,omitnil,omitempty" name:"AvailableEnvironments"`

	// 服务名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 服务描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 服务支持协议,可选值为http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 服务创建时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 服务修改时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 网络类型列表,INNER为内网访问,OUTER为外网访问。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// 内网访问子域名。
	InternalSubDomain *string `json:"InternalSubDomain,omitnil,omitempty" name:"InternalSubDomain"`

	// 外网访问子域名。
	OuterSubDomain *string `json:"OuterSubDomain,omitnil,omitempty" name:"OuterSubDomain"`

	// 内网访问http服务端口号。
	InnerHttpPort *int64 `json:"InnerHttpPort,omitnil,omitempty" name:"InnerHttpPort"`

	// 内网访问https端口号。
	InnerHttpsPort *int64 `json:"InnerHttpsPort,omitnil,omitempty" name:"InnerHttpsPort"`

	// API总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiTotalCount *int64 `json:"ApiTotalCount,omitnil,omitempty" name:"ApiTotalCount"`

	// API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiIdStatusSet []*ApiIdStatus `json:"ApiIdStatusSet,omitnil,omitempty" name:"ApiIdStatusSet"`

	// 使用计划总数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanTotalCount *int64 `json:"UsagePlanTotalCount,omitnil,omitempty" name:"UsagePlanTotalCount"`

	// 使用计划数组。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanList []*UsagePlan `json:"UsagePlanList,omitnil,omitempty" name:"UsagePlanList"`

	// IP版本。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 此服务的用户类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`

	// 预留字段。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SetId *int64 `json:"SetId,omitnil,omitempty" name:"SetId"`

	// 服务绑定的标签。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceReleaseVersionRequest

type DescribeServiceReleaseVersionRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceReleaseVersionRequest

func NewDescribeServiceReleaseVersionRequest() (request *DescribeServiceReleaseVersionRequest)

func (*DescribeServiceReleaseVersionRequest) FromJsonString

func (r *DescribeServiceReleaseVersionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceReleaseVersionRequest) ToJsonString

func (r *DescribeServiceReleaseVersionRequest) ToJsonString() string

type DescribeServiceReleaseVersionRequestParams added in v1.0.426

type DescribeServiceReleaseVersionRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceReleaseVersionResponse

type DescribeServiceReleaseVersionResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceReleaseVersionResponseParams `json:"Response"`
}

func NewDescribeServiceReleaseVersionResponse

func NewDescribeServiceReleaseVersionResponse() (response *DescribeServiceReleaseVersionResponse)

func (*DescribeServiceReleaseVersionResponse) FromJsonString

func (r *DescribeServiceReleaseVersionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceReleaseVersionResponse) ToJsonString

type DescribeServiceReleaseVersionResponseParams added in v1.0.426

type DescribeServiceReleaseVersionResponseParams struct {
	// 服务发布版本列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServiceReleaseVersion `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceReleaseVersionResultVersionListInfo added in v1.0.672

type DescribeServiceReleaseVersionResultVersionListInfo struct {
	// 版本号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 版本描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionDesc *string `json:"VersionDesc,omitnil,omitempty" name:"VersionDesc"`
}

type DescribeServiceRequest

type DescribeServiceRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`
}

func NewDescribeServiceRequest

func NewDescribeServiceRequest() (request *DescribeServiceRequest)

func (*DescribeServiceRequest) FromJsonString

func (r *DescribeServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceRequest) ToJsonString

func (r *DescribeServiceRequest) ToJsonString() string

type DescribeServiceRequestParams added in v1.0.426

type DescribeServiceRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`
}

Predefined struct for user

type DescribeServiceResponse

type DescribeServiceResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceResponseParams `json:"Response"`
}

func NewDescribeServiceResponse

func NewDescribeServiceResponse() (response *DescribeServiceResponse)

func (*DescribeServiceResponse) FromJsonString

func (r *DescribeServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceResponse) ToJsonString

func (r *DescribeServiceResponse) ToJsonString() string

type DescribeServiceResponseParams added in v1.0.426

type DescribeServiceResponseParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务 环境列表。
	AvailableEnvironments []*string `json:"AvailableEnvironments,omitnil,omitempty" name:"AvailableEnvironments"`

	// 服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 服务描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 服务支持协议,可选值为http、https、http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 服务创建时间。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 服务修改时间。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 网络类型列表,INNER为内网访问,OUTER为外网访问。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// 内网访问子域名。
	InternalSubDomain *string `json:"InternalSubDomain,omitnil,omitempty" name:"InternalSubDomain"`

	// 外网访问子域名。
	OuterSubDomain *string `json:"OuterSubDomain,omitnil,omitempty" name:"OuterSubDomain"`

	// 内网访问http服务端口号。
	InnerHttpPort *int64 `json:"InnerHttpPort,omitnil,omitempty" name:"InnerHttpPort"`

	// 内网访问https端口号。
	InnerHttpsPort *int64 `json:"InnerHttpsPort,omitnil,omitempty" name:"InnerHttpsPort"`

	// API总数。
	ApiTotalCount *int64 `json:"ApiTotalCount,omitnil,omitempty" name:"ApiTotalCount"`

	// API列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiIdStatusSet []*ApiIdStatus `json:"ApiIdStatusSet,omitnil,omitempty" name:"ApiIdStatusSet"`

	// 使用计划总数量。
	UsagePlanTotalCount *int64 `json:"UsagePlanTotalCount,omitnil,omitempty" name:"UsagePlanTotalCount"`

	// 使用计划数组。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanList []*UsagePlan `json:"UsagePlanList,omitnil,omitempty" name:"UsagePlanList"`

	// IP版本。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 此服务的用户类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`

	// 预留字段。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SetId *int64 `json:"SetId,omitnil,omitempty" name:"SetId"`

	// 服务绑定的标签。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 独享实例id
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 独享实例name
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 集群类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	SetType *string `json:"SetType,omitnil,omitempty" name:"SetType"`

	// 服务部署的集群类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	DeploymentType *string `json:"DeploymentType,omitnil,omitempty" name:"DeploymentType"`

	// 特殊用途, NULL和DEFAULT表示无特殊用途,其他用途如HTTP_DNS等
	// 注意:此字段可能返回 null,表示取不到有效值。
	SpecialUse *string `json:"SpecialUse,omitnil,omitempty" name:"SpecialUse"`

	// vpc属性,存量可能为空字符串
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceSubDomainMappingsRequest

type DescribeServiceSubDomainMappingsRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务绑定的自定义域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`
}

func NewDescribeServiceSubDomainMappingsRequest

func NewDescribeServiceSubDomainMappingsRequest() (request *DescribeServiceSubDomainMappingsRequest)

func (*DescribeServiceSubDomainMappingsRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceSubDomainMappingsRequest) ToJsonString

type DescribeServiceSubDomainMappingsRequestParams added in v1.0.426

type DescribeServiceSubDomainMappingsRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 服务绑定的自定义域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`
}

Predefined struct for user

type DescribeServiceSubDomainMappingsResponse

type DescribeServiceSubDomainMappingsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceSubDomainMappingsResponseParams `json:"Response"`
}

func NewDescribeServiceSubDomainMappingsResponse

func NewDescribeServiceSubDomainMappingsResponse() (response *DescribeServiceSubDomainMappingsResponse)

func (*DescribeServiceSubDomainMappingsResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceSubDomainMappingsResponse) ToJsonString

type DescribeServiceSubDomainMappingsResponseParams added in v1.0.426

type DescribeServiceSubDomainMappingsResponseParams struct {
	// 自定义路径映射列表。
	Result *ServiceSubDomainMappings `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceSubDomainsRequest

type DescribeServiceSubDomainsRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceSubDomainsRequest

func NewDescribeServiceSubDomainsRequest() (request *DescribeServiceSubDomainsRequest)

func (*DescribeServiceSubDomainsRequest) FromJsonString

func (r *DescribeServiceSubDomainsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceSubDomainsRequest) ToJsonString

func (r *DescribeServiceSubDomainsRequest) ToJsonString() string

type DescribeServiceSubDomainsRequestParams added in v1.0.426

type DescribeServiceSubDomainsRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceSubDomainsResponse

type DescribeServiceSubDomainsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceSubDomainsResponseParams `json:"Response"`
}

func NewDescribeServiceSubDomainsResponse

func NewDescribeServiceSubDomainsResponse() (response *DescribeServiceSubDomainsResponse)

func (*DescribeServiceSubDomainsResponse) FromJsonString

func (r *DescribeServiceSubDomainsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceSubDomainsResponse) ToJsonString

func (r *DescribeServiceSubDomainsResponse) ToJsonString() string

type DescribeServiceSubDomainsResponseParams added in v1.0.426

type DescribeServiceSubDomainsResponseParams struct {
	// 查询服务自定义域名列表。
	Result *DomainSets `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServiceUsagePlanRequest

type DescribeServiceUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为20,最大值为100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeServiceUsagePlanRequest

func NewDescribeServiceUsagePlanRequest() (request *DescribeServiceUsagePlanRequest)

func (*DescribeServiceUsagePlanRequest) FromJsonString

func (r *DescribeServiceUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceUsagePlanRequest) ToJsonString

func (r *DescribeServiceUsagePlanRequest) ToJsonString() string

type DescribeServiceUsagePlanRequestParams added in v1.0.426

type DescribeServiceUsagePlanRequestParams struct {
	// 待查询的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 返回数量,默认为20,最大值为100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeServiceUsagePlanResponse

type DescribeServiceUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServiceUsagePlanResponseParams `json:"Response"`
}

func NewDescribeServiceUsagePlanResponse

func NewDescribeServiceUsagePlanResponse() (response *DescribeServiceUsagePlanResponse)

func (*DescribeServiceUsagePlanResponse) FromJsonString

func (r *DescribeServiceUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServiceUsagePlanResponse) ToJsonString

func (r *DescribeServiceUsagePlanResponse) ToJsonString() string

type DescribeServiceUsagePlanResponseParams added in v1.0.426

type DescribeServiceUsagePlanResponseParams struct {
	// 服务绑定使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServiceUsagePlanSet `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeServicesStatusRequest

type DescribeServicesStatusRequest struct {
	*tchttp.BaseRequest

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ServiceId、ServiceName、NotUsagePlanId、Environment、IpVersion、InstanceId、NetType、EIAMAppId。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeServicesStatusRequest

func NewDescribeServicesStatusRequest() (request *DescribeServicesStatusRequest)

func (*DescribeServicesStatusRequest) FromJsonString

func (r *DescribeServicesStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServicesStatusRequest) ToJsonString

func (r *DescribeServicesStatusRequest) ToJsonString() string

type DescribeServicesStatusRequestParams added in v1.0.426

type DescribeServicesStatusRequestParams struct {
	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件。支持ServiceId、ServiceName、NotUsagePlanId、Environment、IpVersion、InstanceId、NetType、EIAMAppId。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeServicesStatusResponse

type DescribeServicesStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeServicesStatusResponseParams `json:"Response"`
}

func NewDescribeServicesStatusResponse

func NewDescribeServicesStatusResponse() (response *DescribeServicesStatusResponse)

func (*DescribeServicesStatusResponse) FromJsonString

func (r *DescribeServicesStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeServicesStatusResponse) ToJsonString

func (r *DescribeServicesStatusResponse) ToJsonString() string

type DescribeServicesStatusResponseParams added in v1.0.426

type DescribeServicesStatusResponseParams struct {
	// 服务列表查询结果。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ServicesStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUpstreamBindApis added in v1.0.357

type DescribeUpstreamBindApis struct {
	// 总数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 绑定的API信息
	BindApiSet []*BindApiInfo `json:"BindApiSet,omitnil,omitempty" name:"BindApiSet"`
}

type DescribeUpstreamBindApisRequest added in v1.0.357

type DescribeUpstreamBindApisRequest struct {
	*tchttp.BaseRequest

	// 分页大小
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页起始位置
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 后端通道ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// ServiceId和ApiId过滤查询
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeUpstreamBindApisRequest added in v1.0.357

func NewDescribeUpstreamBindApisRequest() (request *DescribeUpstreamBindApisRequest)

func (*DescribeUpstreamBindApisRequest) FromJsonString added in v1.0.357

func (r *DescribeUpstreamBindApisRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUpstreamBindApisRequest) ToJsonString added in v1.0.357

func (r *DescribeUpstreamBindApisRequest) ToJsonString() string

type DescribeUpstreamBindApisRequestParams added in v1.0.426

type DescribeUpstreamBindApisRequestParams struct {
	// 分页大小
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页起始位置
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 后端通道ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// ServiceId和ApiId过滤查询
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeUpstreamBindApisResponse added in v1.0.357

type DescribeUpstreamBindApisResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUpstreamBindApisResponseParams `json:"Response"`
}

func NewDescribeUpstreamBindApisResponse added in v1.0.357

func NewDescribeUpstreamBindApisResponse() (response *DescribeUpstreamBindApisResponse)

func (*DescribeUpstreamBindApisResponse) FromJsonString added in v1.0.357

func (r *DescribeUpstreamBindApisResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUpstreamBindApisResponse) ToJsonString added in v1.0.357

func (r *DescribeUpstreamBindApisResponse) ToJsonString() string

type DescribeUpstreamBindApisResponseParams added in v1.0.426

type DescribeUpstreamBindApisResponseParams struct {
	// 查询结果
	Result *DescribeUpstreamBindApis `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUpstreamInfo added in v1.0.357

type DescribeUpstreamInfo struct {
	// 查询总数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 查询列表
	UpstreamSet []*UpstreamInfo `json:"UpstreamSet,omitnil,omitempty" name:"UpstreamSet"`
}

type DescribeUpstreamsRequest added in v1.0.357

type DescribeUpstreamsRequest struct {
	*tchttp.BaseRequest

	// 分页大小
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页起始位置
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件,支持后端通道ID(UpstreamId)、后端通道名字(UpstreamName)过滤查询
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeUpstreamsRequest added in v1.0.357

func NewDescribeUpstreamsRequest() (request *DescribeUpstreamsRequest)

func (*DescribeUpstreamsRequest) FromJsonString added in v1.0.357

func (r *DescribeUpstreamsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUpstreamsRequest) ToJsonString added in v1.0.357

func (r *DescribeUpstreamsRequest) ToJsonString() string

type DescribeUpstreamsRequestParams added in v1.0.426

type DescribeUpstreamsRequestParams struct {
	// 分页大小
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页起始位置
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 过滤条件,支持后端通道ID(UpstreamId)、后端通道名字(UpstreamName)过滤查询
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeUpstreamsResponse added in v1.0.357

type DescribeUpstreamsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUpstreamsResponseParams `json:"Response"`
}

func NewDescribeUpstreamsResponse added in v1.0.357

func NewDescribeUpstreamsResponse() (response *DescribeUpstreamsResponse)

func (*DescribeUpstreamsResponse) FromJsonString added in v1.0.357

func (r *DescribeUpstreamsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUpstreamsResponse) ToJsonString added in v1.0.357

func (r *DescribeUpstreamsResponse) ToJsonString() string

type DescribeUpstreamsResponseParams added in v1.0.426

type DescribeUpstreamsResponseParams struct {
	// 查询结果
	Result *DescribeUpstreamInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUsagePlanEnvironmentsRequest

type DescribeUsagePlanEnvironmentsRequest struct {
	*tchttp.BaseRequest

	// 待查询的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 定义类型,取值为 API、SERVICE,默认值为 SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeUsagePlanEnvironmentsRequest

func NewDescribeUsagePlanEnvironmentsRequest() (request *DescribeUsagePlanEnvironmentsRequest)

func (*DescribeUsagePlanEnvironmentsRequest) FromJsonString

func (r *DescribeUsagePlanEnvironmentsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanEnvironmentsRequest) ToJsonString

func (r *DescribeUsagePlanEnvironmentsRequest) ToJsonString() string

type DescribeUsagePlanEnvironmentsRequestParams added in v1.0.426

type DescribeUsagePlanEnvironmentsRequestParams struct {
	// 待查询的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 定义类型,取值为 API、SERVICE,默认值为 SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeUsagePlanEnvironmentsResponse

type DescribeUsagePlanEnvironmentsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsagePlanEnvironmentsResponseParams `json:"Response"`
}

func NewDescribeUsagePlanEnvironmentsResponse

func NewDescribeUsagePlanEnvironmentsResponse() (response *DescribeUsagePlanEnvironmentsResponse)

func (*DescribeUsagePlanEnvironmentsResponse) FromJsonString

func (r *DescribeUsagePlanEnvironmentsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanEnvironmentsResponse) ToJsonString

type DescribeUsagePlanEnvironmentsResponseParams added in v1.0.426

type DescribeUsagePlanEnvironmentsResponseParams struct {
	// 使用计划绑定详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlanEnvironmentStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUsagePlanRequest

type DescribeUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 待查询的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`
}

func NewDescribeUsagePlanRequest

func NewDescribeUsagePlanRequest() (request *DescribeUsagePlanRequest)

func (*DescribeUsagePlanRequest) FromJsonString

func (r *DescribeUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanRequest) ToJsonString

func (r *DescribeUsagePlanRequest) ToJsonString() string

type DescribeUsagePlanRequestParams added in v1.0.426

type DescribeUsagePlanRequestParams struct {
	// 待查询的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`
}

Predefined struct for user

type DescribeUsagePlanResponse

type DescribeUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsagePlanResponseParams `json:"Response"`
}

func NewDescribeUsagePlanResponse

func NewDescribeUsagePlanResponse() (response *DescribeUsagePlanResponse)

func (*DescribeUsagePlanResponse) FromJsonString

func (r *DescribeUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanResponse) ToJsonString

func (r *DescribeUsagePlanResponse) ToJsonString() string

type DescribeUsagePlanResponseParams added in v1.0.426

type DescribeUsagePlanResponseParams struct {
	// 使用计划详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlanInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUsagePlanSecretIdsRequest

type DescribeUsagePlanSecretIdsRequest struct {
	*tchttp.BaseRequest

	// 绑定的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeUsagePlanSecretIdsRequest

func NewDescribeUsagePlanSecretIdsRequest() (request *DescribeUsagePlanSecretIdsRequest)

func (*DescribeUsagePlanSecretIdsRequest) FromJsonString

func (r *DescribeUsagePlanSecretIdsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanSecretIdsRequest) ToJsonString

func (r *DescribeUsagePlanSecretIdsRequest) ToJsonString() string

type DescribeUsagePlanSecretIdsRequestParams added in v1.0.426

type DescribeUsagePlanSecretIdsRequestParams struct {
	// 绑定的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeUsagePlanSecretIdsResponse

type DescribeUsagePlanSecretIdsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsagePlanSecretIdsResponseParams `json:"Response"`
}

func NewDescribeUsagePlanSecretIdsResponse

func NewDescribeUsagePlanSecretIdsResponse() (response *DescribeUsagePlanSecretIdsResponse)

func (*DescribeUsagePlanSecretIdsResponse) FromJsonString

func (r *DescribeUsagePlanSecretIdsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlanSecretIdsResponse) ToJsonString

func (r *DescribeUsagePlanSecretIdsResponse) ToJsonString() string

type DescribeUsagePlanSecretIdsResponseParams added in v1.0.426

type DescribeUsagePlanSecretIdsResponseParams struct {
	// 使用计划绑定的密钥列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlanBindSecretStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeUsagePlansStatusRequest

type DescribeUsagePlansStatusRequest struct {
	*tchttp.BaseRequest

	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeUsagePlansStatusRequest

func NewDescribeUsagePlansStatusRequest() (request *DescribeUsagePlansStatusRequest)

func (*DescribeUsagePlansStatusRequest) FromJsonString

func (r *DescribeUsagePlansStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlansStatusRequest) ToJsonString

func (r *DescribeUsagePlansStatusRequest) ToJsonString() string

type DescribeUsagePlansStatusRequestParams added in v1.0.426

type DescribeUsagePlansStatusRequestParams struct {
	// 返回数量,默认为 20,最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeUsagePlansStatusResponse

type DescribeUsagePlansStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUsagePlansStatusResponseParams `json:"Response"`
}

func NewDescribeUsagePlansStatusResponse

func NewDescribeUsagePlansStatusResponse() (response *DescribeUsagePlansStatusResponse)

func (*DescribeUsagePlansStatusResponse) FromJsonString

func (r *DescribeUsagePlansStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUsagePlansStatusResponse) ToJsonString

func (r *DescribeUsagePlansStatusResponse) ToJsonString() string

type DescribeUsagePlansStatusResponseParams added in v1.0.426

type DescribeUsagePlansStatusResponseParams struct {
	// 使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlansStatus `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DetachPluginRequest added in v1.0.204

type DetachPluginRequest struct {
	*tchttp.BaseRequest

	// 要解绑的API网关插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要操作的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要操作API的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 要解绑的API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

func NewDetachPluginRequest added in v1.0.204

func NewDetachPluginRequest() (request *DetachPluginRequest)

func (*DetachPluginRequest) FromJsonString added in v1.0.204

func (r *DetachPluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DetachPluginRequest) ToJsonString added in v1.0.204

func (r *DetachPluginRequest) ToJsonString() string

type DetachPluginRequestParams added in v1.0.426

type DetachPluginRequestParams struct {
	// 要解绑的API网关插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要操作的服务ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 要操作API的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 要解绑的API ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

Predefined struct for user

type DetachPluginResponse added in v1.0.204

type DetachPluginResponse struct {
	*tchttp.BaseResponse
	Response *DetachPluginResponseParams `json:"Response"`
}

func NewDetachPluginResponse added in v1.0.204

func NewDetachPluginResponse() (response *DetachPluginResponse)

func (*DetachPluginResponse) FromJsonString added in v1.0.204

func (r *DetachPluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DetachPluginResponse) ToJsonString added in v1.0.204

func (r *DetachPluginResponse) ToJsonString() string

type DetachPluginResponseParams added in v1.0.426

type DetachPluginResponseParams struct {
	// 解绑操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableApiKeyRequest

type DisableApiKeyRequest struct {
	*tchttp.BaseRequest

	// 待禁用的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

func NewDisableApiKeyRequest

func NewDisableApiKeyRequest() (request *DisableApiKeyRequest)

func (*DisableApiKeyRequest) FromJsonString

func (r *DisableApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableApiKeyRequest) ToJsonString

func (r *DisableApiKeyRequest) ToJsonString() string

type DisableApiKeyRequestParams added in v1.0.426

type DisableApiKeyRequestParams struct {
	// 待禁用的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

Predefined struct for user

type DisableApiKeyResponse

type DisableApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *DisableApiKeyResponseParams `json:"Response"`
}

func NewDisableApiKeyResponse

func NewDisableApiKeyResponse() (response *DisableApiKeyResponse)

func (*DisableApiKeyResponse) FromJsonString

func (r *DisableApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableApiKeyResponse) ToJsonString

func (r *DisableApiKeyResponse) ToJsonString() string

type DisableApiKeyResponseParams added in v1.0.426

type DisableApiKeyResponseParams struct {
	// 禁用密钥操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DomainSetList

type DomainSetList struct {
	// 域名名称。
	DomainName *string `json:"DomainName,omitnil,omitempty" name:"DomainName"`

	// 域名解析状态。1 表示正常解析,0 表示解析失败。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 证书ID。
	CertificateId *string `json:"CertificateId,omitnil,omitempty" name:"CertificateId"`

	// 是否使用默认路径映射。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 自定义域名协议类型。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 网络类型('INNER' 或 'OUTER')。
	NetType *string `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
	IsForcedHttps *bool `json:"IsForcedHttps,omitnil,omitempty" name:"IsForcedHttps"`

	// 域名备案注册状态
	RegistrationStatus *bool `json:"RegistrationStatus,omitnil,omitempty" name:"RegistrationStatus"`
}

type DomainSets

type DomainSets struct {
	// 服务下的自定义域名数量。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 自定义服务域名列表。
	DomainSet []*DomainSetList `json:"DomainSet,omitnil,omitempty" name:"DomainSet"`
}

type EnableApiKeyRequest

type EnableApiKeyRequest struct {
	*tchttp.BaseRequest

	// 待启用的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

func NewEnableApiKeyRequest

func NewEnableApiKeyRequest() (request *EnableApiKeyRequest)

func (*EnableApiKeyRequest) FromJsonString

func (r *EnableApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableApiKeyRequest) ToJsonString

func (r *EnableApiKeyRequest) ToJsonString() string

type EnableApiKeyRequestParams added in v1.0.426

type EnableApiKeyRequestParams struct {
	// 待启用的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`
}

Predefined struct for user

type EnableApiKeyResponse

type EnableApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *EnableApiKeyResponseParams `json:"Response"`
}

func NewEnableApiKeyResponse

func NewEnableApiKeyResponse() (response *EnableApiKeyResponse)

func (*EnableApiKeyResponse) FromJsonString

func (r *EnableApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableApiKeyResponse) ToJsonString

func (r *EnableApiKeyResponse) ToJsonString() string

type EnableApiKeyResponseParams added in v1.0.426

type EnableApiKeyResponseParams struct {
	// 启动密钥操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Environment

type Environment struct {
	// 环境名称。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 访问路径。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 发布状态,1 表示已发布,0 表示未发布。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 运行版本。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 创建时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
}

type EnvironmentStrategy

type EnvironmentStrategy struct {
	// 环境名
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 限流值
	Quota *int64 `json:"Quota,omitnil,omitempty" name:"Quota"`
}

type ErrorCodes

type ErrorCodes struct {
	// 自定义响应配置错误码。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Code *int64 `json:"Code,omitnil,omitempty" name:"Code"`

	// 自定义响应配置错误信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Msg *string `json:"Msg,omitnil,omitempty" name:"Msg"`

	// 自定义响应配置错误码备注。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// 自定义错误码转换。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConvertedCode *int64 `json:"ConvertedCode,omitnil,omitempty" name:"ConvertedCode"`

	// 是否需要开启错误码转换。
	// 注意:此字段可能返回 null,表示取不到有效值。
	NeedConvert *bool `json:"NeedConvert,omitnil,omitempty" name:"NeedConvert"`
}

type Filter

type Filter struct {
	// 需要过滤的字段。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 字段的过滤值。
	Values []*string `json:"Values,omitnil,omitempty" name:"Values"`
}

type HealthCheckConf

type HealthCheckConf struct {
	// 是否开启健康检查。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsHealthCheck *bool `json:"IsHealthCheck,omitnil,omitempty" name:"IsHealthCheck"`

	// 健康检查阈值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RequestVolumeThreshold *int64 `json:"RequestVolumeThreshold,omitnil,omitempty" name:"RequestVolumeThreshold"`

	// 窗口大小。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SleepWindowInMilliseconds *int64 `json:"SleepWindowInMilliseconds,omitnil,omitempty" name:"SleepWindowInMilliseconds"`

	// 阈值百分比。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ErrorThresholdPercentage *int64 `json:"ErrorThresholdPercentage,omitnil,omitempty" name:"ErrorThresholdPercentage"`
}

type IPStrategiesStatus added in v1.0.701

type IPStrategiesStatus struct {
	// 策略数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 策略列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StrategySet []*IPStrategy `json:"StrategySet,omitnil,omitempty" name:"StrategySet"`
}

type IPStrategy

type IPStrategy struct {
	// 策略唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 用户自定义策略名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StrategyName *string `json:"StrategyName,omitnil,omitempty" name:"StrategyName"`

	// 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StrategyType *string `json:"StrategyType,omitnil,omitempty" name:"StrategyType"`

	// IP列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	StrategyData *string `json:"StrategyData,omitnil,omitempty" name:"StrategyData"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 修改时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 策略绑定的API数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindApiTotalCount *int64 `json:"BindApiTotalCount,omitnil,omitempty" name:"BindApiTotalCount"`

	// 绑定的API详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindApis []*DesApisStatus `json:"BindApis,omitnil,omitempty" name:"BindApis"`
}

type IPStrategyApi

type IPStrategyApi struct {
	// API 唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义的 API 名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API 类型。取值为NORMAL(普通API)和TSF (微服务API)。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 的路径。如 /path。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 的请求方法。如 GET。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// API 已经绑定的其他策略唯一ID。
	OtherIPStrategyId *string `json:"OtherIPStrategyId,omitnil,omitempty" name:"OtherIPStrategyId"`

	// API 已经绑定的环境。
	OtherEnvironmentName *string `json:"OtherEnvironmentName,omitnil,omitempty" name:"OtherEnvironmentName"`
}

type IPStrategyApiStatus

type IPStrategyApiStatus struct {
	// 环境绑定API数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 环境绑定API详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiIdStatusSet []*IPStrategyApi `json:"ApiIdStatusSet,omitnil,omitempty" name:"ApiIdStatusSet"`
}

type ImportOpenApiRequest added in v1.0.482

type ImportOpenApiRequest struct {
	*tchttp.BaseRequest

	// API所在的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// openAPI正文内容。
	Content *string `json:"Content,omitnil,omitempty" name:"Content"`

	// Content格式,只能是YAML或者JSON,默认是YAML。
	EncodeType *string `json:"EncodeType,omitnil,omitempty" name:"EncodeType"`

	// Content版本,默认是openAPI,目前只支持openAPI。
	ContentVersion *string `json:"ContentVersion,omitnil,omitempty" name:"ContentVersion"`
}

func NewImportOpenApiRequest added in v1.0.482

func NewImportOpenApiRequest() (request *ImportOpenApiRequest)

func (*ImportOpenApiRequest) FromJsonString added in v1.0.482

func (r *ImportOpenApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportOpenApiRequest) ToJsonString added in v1.0.482

func (r *ImportOpenApiRequest) ToJsonString() string

type ImportOpenApiRequestParams added in v1.0.482

type ImportOpenApiRequestParams struct {
	// API所在的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// openAPI正文内容。
	Content *string `json:"Content,omitnil,omitempty" name:"Content"`

	// Content格式,只能是YAML或者JSON,默认是YAML。
	EncodeType *string `json:"EncodeType,omitnil,omitempty" name:"EncodeType"`

	// Content版本,默认是openAPI,目前只支持openAPI。
	ContentVersion *string `json:"ContentVersion,omitnil,omitempty" name:"ContentVersion"`
}

Predefined struct for user

type ImportOpenApiResponse added in v1.0.482

type ImportOpenApiResponse struct {
	*tchttp.BaseResponse
	Response *ImportOpenApiResponseParams `json:"Response"`
}

func NewImportOpenApiResponse added in v1.0.482

func NewImportOpenApiResponse() (response *ImportOpenApiResponse)

func (*ImportOpenApiResponse) FromJsonString added in v1.0.482

func (r *ImportOpenApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportOpenApiResponse) ToJsonString added in v1.0.482

func (r *ImportOpenApiResponse) ToJsonString() string

type ImportOpenApiResponseParams added in v1.0.482

type ImportOpenApiResponseParams struct {
	// 导入OpenApi返回参数。
	Result *CreateApiRspSet `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type InstanceChargePrepaid added in v1.0.288

type InstanceChargePrepaid struct {
	// 自动续费标示
	RenewFlag *string `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`

	// 预付费到期时间
	ExpiredTime *string `json:"ExpiredTime,omitnil,omitempty" name:"ExpiredTime"`
}

type InstanceDetail added in v1.0.288

type InstanceDetail struct {
	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 可用区
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 独享实例名字
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 独享实例描述
	InstanceDescription *string `json:"InstanceDescription,omitnil,omitempty" name:"InstanceDescription"`

	// 独享实例计费类型
	InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"`

	// 独享实例状态
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// 独享实例预付费类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`

	// 独享实例类型
	InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// 独享实例网络类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	NetworkConfig *NetworkConfig `json:"NetworkConfig,omitnil,omitempty" name:"NetworkConfig"`

	// 独享实例vpc配置
	VpcConfig *VpcConfig `json:"VpcConfig,omitnil,omitempty" name:"VpcConfig"`

	// 独享实例参数配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	Parameters []*ParameterInfo `json:"Parameters,omitnil,omitempty" name:"Parameters"`

	// 独享实例隔离时间
	IsolationStartedTime *string `json:"IsolationStartedTime,omitnil,omitempty" name:"IsolationStartedTime"`

	// 创建时间
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 可用区列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Zones []*string `json:"Zones,omitnil,omitempty" name:"Zones"`
}

type InstanceInfo added in v1.0.288

type InstanceInfo struct {
	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 独享实例name
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 独享实例描述
	InstanceDescription *string `json:"InstanceDescription,omitnil,omitempty" name:"InstanceDescription"`

	// 独享实例计费类型
	InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"`

	// 独享实例类型
	InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// 独享实例状态
	InstanceState *string `json:"InstanceState,omitnil,omitempty" name:"InstanceState"`

	// 独享实例创建时间
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 订单号
	// 注意:此字段可能返回 null,表示取不到有效值。
	DealName *string `json:"DealName,omitnil,omitempty" name:"DealName"`

	// 资源ID同唯一id
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// 公网IP列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	OuterIpList []*string `json:"OuterIpList,omitnil,omitempty" name:"OuterIpList"`

	// 内网IP列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	InnerIpList []*string `json:"InnerIpList,omitnil,omitempty" name:"InnerIpList"`

	// 专享实例计费信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`

	// 所属vpc
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`
}

type InstanceParameterInput added in v1.0.288

type InstanceParameterInput struct {
	// ServiceRequestNumPreSec,ApiRequestNumPreSec
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 参数值
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type InstanceSummary added in v1.0.419

type InstanceSummary struct {
	// 专享实例总数
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 专享实例列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceSet []*InstanceInfo `json:"InstanceSet,omitnil,omitempty" name:"InstanceSet"`
}

type K8sLabel added in v1.0.357

type K8sLabel struct {
	// Label的Key
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

	// Label的Value
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type K8sService added in v1.0.357

type K8sService struct {
	// 权重
	Weight *int64 `json:"Weight,omitnil,omitempty" name:"Weight"`

	// k8s集群ID
	ClusterId *string `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// 容器命名空间
	Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`

	// 容器服务的名字
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 服务的端口
	Port *int64 `json:"Port,omitnil,omitempty" name:"Port"`

	// 额外选择的Pod的Label
	ExtraLabels []*K8sLabel `json:"ExtraLabels,omitnil,omitempty" name:"ExtraLabels"`

	// 自定义的服务名字,可选
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

type LogQuery

type LogQuery struct {
	// 检索字段
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 操作符
	Operator *string `json:"Operator,omitnil,omitempty" name:"Operator"`

	// 检索值
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type MicroService

type MicroService struct {
	// 微服务集群ID。
	ClusterId *string `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// 微服务命名空间ID。
	NamespaceId *string `json:"NamespaceId,omitnil,omitempty" name:"NamespaceId"`

	// 微服务名称。
	MicroServiceName *string `json:"MicroServiceName,omitnil,omitempty" name:"MicroServiceName"`
}

type MicroServiceReq

type MicroServiceReq struct {
	// 微服务集群。
	ClusterId *string `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// 微服务命名空间。
	NamespaceId *string `json:"NamespaceId,omitnil,omitempty" name:"NamespaceId"`

	// 微服务名称。
	MicroServiceName *string `json:"MicroServiceName,omitnil,omitempty" name:"MicroServiceName"`
}

type ModifyAPIDocRequest

type ModifyAPIDocRequest struct {
	*tchttp.BaseRequest

	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// 服务名称
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 生成文档的API列表
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

func NewModifyAPIDocRequest

func NewModifyAPIDocRequest() (request *ModifyAPIDocRequest)

func (*ModifyAPIDocRequest) FromJsonString

func (r *ModifyAPIDocRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAPIDocRequest) ToJsonString

func (r *ModifyAPIDocRequest) ToJsonString() string

type ModifyAPIDocRequestParams added in v1.0.426

type ModifyAPIDocRequestParams struct {
	// API文档名称
	ApiDocName *string `json:"ApiDocName,omitnil,omitempty" name:"ApiDocName"`

	// 服务名称
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 环境名称
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 生成文档的API列表
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

Predefined struct for user

type ModifyAPIDocResponse

type ModifyAPIDocResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAPIDocResponseParams `json:"Response"`
}

func NewModifyAPIDocResponse

func NewModifyAPIDocResponse() (response *ModifyAPIDocResponse)

func (*ModifyAPIDocResponse) FromJsonString

func (r *ModifyAPIDocResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyAPIDocResponse) ToJsonString

func (r *ModifyAPIDocResponse) ToJsonString() string

type ModifyAPIDocResponseParams added in v1.0.426

type ModifyAPIDocResponseParams struct {
	// API文档基本信息
	Result *APIDoc `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyApiAppRequest added in v1.0.209

type ModifyApiAppRequest struct {
	*tchttp.BaseRequest

	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 修改的应用名称
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 修改的应用描述
	ApiAppDesc *string `json:"ApiAppDesc,omitnil,omitempty" name:"ApiAppDesc"`
}

func NewModifyApiAppRequest added in v1.0.209

func NewModifyApiAppRequest() (request *ModifyApiAppRequest)

func (*ModifyApiAppRequest) FromJsonString added in v1.0.209

func (r *ModifyApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiAppRequest) ToJsonString added in v1.0.209

func (r *ModifyApiAppRequest) ToJsonString() string

type ModifyApiAppRequestParams added in v1.0.426

type ModifyApiAppRequestParams struct {
	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 修改的应用名称
	ApiAppName *string `json:"ApiAppName,omitnil,omitempty" name:"ApiAppName"`

	// 修改的应用描述
	ApiAppDesc *string `json:"ApiAppDesc,omitnil,omitempty" name:"ApiAppDesc"`
}

Predefined struct for user

type ModifyApiAppResponse added in v1.0.209

type ModifyApiAppResponse struct {
	*tchttp.BaseResponse
	Response *ModifyApiAppResponseParams `json:"Response"`
}

func NewModifyApiAppResponse added in v1.0.209

func NewModifyApiAppResponse() (response *ModifyApiAppResponse)

func (*ModifyApiAppResponse) FromJsonString added in v1.0.209

func (r *ModifyApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiAppResponse) ToJsonString added in v1.0.209

func (r *ModifyApiAppResponse) ToJsonString() string

type ModifyApiAppResponseParams added in v1.0.426

type ModifyApiAppResponseParams struct {
	// 修改操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyApiEnvironmentStrategyRequest

type ModifyApiEnvironmentStrategyRequest struct {
	*tchttp.BaseRequest

	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 限流值。
	Strategy *int64 `json:"Strategy,omitnil,omitempty" name:"Strategy"`

	// 环境名。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewModifyApiEnvironmentStrategyRequest

func NewModifyApiEnvironmentStrategyRequest() (request *ModifyApiEnvironmentStrategyRequest)

func (*ModifyApiEnvironmentStrategyRequest) FromJsonString

func (r *ModifyApiEnvironmentStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiEnvironmentStrategyRequest) ToJsonString

func (r *ModifyApiEnvironmentStrategyRequest) ToJsonString() string

type ModifyApiEnvironmentStrategyRequestParams added in v1.0.426

type ModifyApiEnvironmentStrategyRequestParams struct {
	// 服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 限流值。
	Strategy *int64 `json:"Strategy,omitnil,omitempty" name:"Strategy"`

	// 环境名。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type ModifyApiEnvironmentStrategyResponse

type ModifyApiEnvironmentStrategyResponse struct {
	*tchttp.BaseResponse
	Response *ModifyApiEnvironmentStrategyResponseParams `json:"Response"`
}

func NewModifyApiEnvironmentStrategyResponse

func NewModifyApiEnvironmentStrategyResponse() (response *ModifyApiEnvironmentStrategyResponse)

func (*ModifyApiEnvironmentStrategyResponse) FromJsonString

func (r *ModifyApiEnvironmentStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiEnvironmentStrategyResponse) ToJsonString

func (r *ModifyApiEnvironmentStrategyResponse) ToJsonString() string

type ModifyApiEnvironmentStrategyResponseParams added in v1.0.426

type ModifyApiEnvironmentStrategyResponseParams struct {
	// 修改操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyApiIncrementRequest

type ModifyApiIncrementRequest struct {
	*tchttp.BaseRequest

	// 服务ID
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 接口ID
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 需要修改的API auth类型(可选择OAUTH-授权API)
	BusinessType *string `json:"BusinessType,omitnil,omitempty" name:"BusinessType"`

	// oauth接口需要修改的公钥值
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// oauth接口重定向地址
	LoginRedirectUrl *string `json:"LoginRedirectUrl,omitnil,omitempty" name:"LoginRedirectUrl"`
}

func NewModifyApiIncrementRequest

func NewModifyApiIncrementRequest() (request *ModifyApiIncrementRequest)

func (*ModifyApiIncrementRequest) FromJsonString

func (r *ModifyApiIncrementRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiIncrementRequest) ToJsonString

func (r *ModifyApiIncrementRequest) ToJsonString() string

type ModifyApiIncrementRequestParams added in v1.0.426

type ModifyApiIncrementRequestParams struct {
	// 服务ID
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 接口ID
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 需要修改的API auth类型(可选择OAUTH-授权API)
	BusinessType *string `json:"BusinessType,omitnil,omitempty" name:"BusinessType"`

	// oauth接口需要修改的公钥值
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// oauth接口重定向地址
	LoginRedirectUrl *string `json:"LoginRedirectUrl,omitnil,omitempty" name:"LoginRedirectUrl"`
}

Predefined struct for user

type ModifyApiIncrementResponse

type ModifyApiIncrementResponse struct {
	*tchttp.BaseResponse
	Response *ModifyApiIncrementResponseParams `json:"Response"`
}

func NewModifyApiIncrementResponse

func NewModifyApiIncrementResponse() (response *ModifyApiIncrementResponse)

func (*ModifyApiIncrementResponse) FromJsonString

func (r *ModifyApiIncrementResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiIncrementResponse) ToJsonString

func (r *ModifyApiIncrementResponse) ToJsonString() string

type ModifyApiIncrementResponseParams added in v1.0.426

type ModifyApiIncrementResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyApiRequest

type ModifyApiRequest struct {
	*tchttp.BaseRequest

	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// 请求的前端配置。
	RequestConfig *RequestConfig `json:"RequestConfig,omitnil,omitempty" name:"RequestConfig"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义的 API 名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 用户自定义的 API 接口描述。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// API 类型,支持NORMAL和TSF,默认为NORMAL。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
	AuthRequired *bool `json:"AuthRequired,omitnil,omitempty" name:"AuthRequired"`

	// API 的后端服务超时时间,单位是秒。
	ServiceTimeout *int64 `json:"ServiceTimeout,omitnil,omitempty" name:"ServiceTimeout"`

	// API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 是否需要开启跨域,Ture 表示需要,False 表示不需要。
	EnableCORS *bool `json:"EnableCORS,omitnil,omitempty" name:"EnableCORS"`

	// 常量参数。
	ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitnil,omitempty" name:"ConstantParameters"`

	// 前端请求参数。
	RequestParameters []*ReqParameter `json:"RequestParameters,omitnil,omitempty" name:"RequestParameters"`

	// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api   OAUTH:授权API。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
	ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitnil,omitempty" name:"ServiceMockReturnMessage"`

	// API绑定微服务列表。
	MicroServices []*MicroServiceReq `json:"MicroServices,omitnil,omitempty" name:"MicroServices"`

	// 微服务的负载均衡配置。
	ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitnil,omitempty" name:"ServiceTsfLoadBalanceConf"`

	// 微服务的健康检查配置。
	ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitnil,omitempty" name:"ServiceTsfHealthCheckConf"`

	// target类型负载均衡配置。(内测阶段)
	TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitnil,omitempty" name:"TargetServicesLoadBalanceConf"`

	// target健康检查配置。(内测阶段)
	TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitnil,omitempty" name:"TargetServicesHealthCheckConf"`

	// scf 函数名称。当后端类型是SCF时生效。
	ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitnil,omitempty" name:"ServiceScfFunctionName"`

	// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionName"`

	// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionName"`

	// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionName"`

	// scf 函数命名空间。当后端类型是SCF时生效。
	ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitnil,omitempty" name:"ServiceScfFunctionNamespace"`

	// scf函数版本。当后端类型是SCF时生效。
	ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitnil,omitempty" name:"ServiceScfFunctionQualifier"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`

	// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`

	// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`

	// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`

	// 是否开启响应集成。当后端类型是SCF时生效。
	ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitnil,omitempty" name:"ServiceScfIsIntegratedResponse"`

	// 开始调试后计费。(云市场预留字段)
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 标签。
	TagSpecifications *Tag `json:"TagSpecifications,omitnil,omitempty" name:"TagSpecifications"`

	// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
	IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitnil,omitempty" name:"IsDeleteResponseErrorCodes"`

	// 返回类型。
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// 自定义响应配置成功响应示例。
	ResponseSuccessExample *string `json:"ResponseSuccessExample,omitnil,omitempty" name:"ResponseSuccessExample"`

	// 自定义响应配置失败响应示例。
	ResponseFailExample *string `json:"ResponseFailExample,omitnil,omitempty" name:"ResponseFailExample"`

	// API 的后端服务配置。
	ServiceConfig *ServiceConfig `json:"ServiceConfig,omitnil,omitempty" name:"ServiceConfig"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// API的后端服务参数。
	ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitnil,omitempty" name:"ServiceParameters"`

	// oauth配置。当AuthType是OAUTH时生效。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 用户自定义错误码配置。
	ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitnil,omitempty" name:"ResponseErrorCodes"`

	// 是否开启Base64编码,只有后端为scf时才会生效。
	IsBase64Encoded *bool `json:"IsBase64Encoded,omitnil,omitempty" name:"IsBase64Encoded"`

	// 是否开启Base64编码的header触发,只有后端为scf时才会生效。
	IsBase64Trigger *bool `json:"IsBase64Trigger,omitnil,omitempty" name:"IsBase64Trigger"`

	// Header触发规则,总规则数不能超过10。
	Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitnil,omitempty" name:"Base64EncodedTriggerRules"`

	// 事件总线ID。
	EventBusId *string `json:"EventBusId,omitnil,omitempty" name:"EventBusId"`

	// scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
	ServiceScfFunctionType *string `json:"ServiceScfFunctionType,omitnil,omitempty" name:"ServiceScfFunctionType"`

	// 是否开启SCF Event异步调用。
	ServiceScfEventIsAsyncCall *bool `json:"ServiceScfEventIsAsyncCall,omitnil,omitempty" name:"ServiceScfEventIsAsyncCall"`

	// EIAM应用类型。
	EIAMAppType *string `json:"EIAMAppType,omitnil,omitempty" name:"EIAMAppType"`

	// EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
	EIAMAuthType *string `json:"EIAMAuthType,omitnil,omitempty" name:"EIAMAuthType"`

	// EIAM应用Token 有效时间,单位为秒,默认为7200秒。
	EIAMAppId *string `json:"EIAMAppId,omitnil,omitempty" name:"EIAMAppId"`

	// EIAM应用ID。
	TokenTimeout *int64 `json:"TokenTimeout,omitnil,omitempty" name:"TokenTimeout"`
}

func NewModifyApiRequest

func NewModifyApiRequest() (request *ModifyApiRequest)

func (*ModifyApiRequest) FromJsonString

func (r *ModifyApiRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiRequest) ToJsonString

func (r *ModifyApiRequest) ToJsonString() string

type ModifyApiRequestParams added in v1.0.426

type ModifyApiRequestParams struct {
	// API 所在的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
	ServiceType *string `json:"ServiceType,omitnil,omitempty" name:"ServiceType"`

	// 请求的前端配置。
	RequestConfig *RequestConfig `json:"RequestConfig,omitnil,omitempty" name:"RequestConfig"`

	// API 接口唯一 ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// 用户自定义的 API 名称。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// 用户自定义的 API 接口描述。
	ApiDesc *string `json:"ApiDesc,omitnil,omitempty" name:"ApiDesc"`

	// API 类型,支持NORMAL和TSF,默认为NORMAL。
	ApiType *string `json:"ApiType,omitnil,omitempty" name:"ApiType"`

	// API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
	AuthType *string `json:"AuthType,omitnil,omitempty" name:"AuthType"`

	// 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
	AuthRequired *bool `json:"AuthRequired,omitnil,omitempty" name:"AuthRequired"`

	// API 的后端服务超时时间,单位是秒。
	ServiceTimeout *int64 `json:"ServiceTimeout,omitnil,omitempty" name:"ServiceTimeout"`

	// API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 是否需要开启跨域,Ture 表示需要,False 表示不需要。
	EnableCORS *bool `json:"EnableCORS,omitnil,omitempty" name:"EnableCORS"`

	// 常量参数。
	ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitnil,omitempty" name:"ConstantParameters"`

	// 前端请求参数。
	RequestParameters []*ReqParameter `json:"RequestParameters,omitnil,omitempty" name:"RequestParameters"`

	// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api   OAUTH:授权API。
	ApiBusinessType *string `json:"ApiBusinessType,omitnil,omitempty" name:"ApiBusinessType"`

	// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
	ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitnil,omitempty" name:"ServiceMockReturnMessage"`

	// API绑定微服务列表。
	MicroServices []*MicroServiceReq `json:"MicroServices,omitnil,omitempty" name:"MicroServices"`

	// 微服务的负载均衡配置。
	ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitnil,omitempty" name:"ServiceTsfLoadBalanceConf"`

	// 微服务的健康检查配置。
	ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitnil,omitempty" name:"ServiceTsfHealthCheckConf"`

	// target类型负载均衡配置。(内测阶段)
	TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitnil,omitempty" name:"TargetServicesLoadBalanceConf"`

	// target健康检查配置。(内测阶段)
	TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitnil,omitempty" name:"TargetServicesHealthCheckConf"`

	// scf 函数名称。当后端类型是SCF时生效。
	ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitnil,omitempty" name:"ServiceScfFunctionName"`

	// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionName"`

	// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionName"`

	// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionName"`

	// scf 函数命名空间。当后端类型是SCF时生效。
	ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitnil,omitempty" name:"ServiceScfFunctionNamespace"`

	// scf函数版本。当后端类型是SCF时生效。
	ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitnil,omitempty" name:"ServiceScfFunctionQualifier"`

	// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`

	// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`

	// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`

	// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`

	// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
	ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitnil,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`

	// 是否开启响应集成。当后端类型是SCF时生效。
	ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitnil,omitempty" name:"ServiceScfIsIntegratedResponse"`

	// 开始调试后计费。(云市场预留字段)
	IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitnil,omitempty" name:"IsDebugAfterCharge"`

	// 标签。
	TagSpecifications *Tag `json:"TagSpecifications,omitnil,omitempty" name:"TagSpecifications"`

	// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
	IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitnil,omitempty" name:"IsDeleteResponseErrorCodes"`

	// 返回类型。
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// 自定义响应配置成功响应示例。
	ResponseSuccessExample *string `json:"ResponseSuccessExample,omitnil,omitempty" name:"ResponseSuccessExample"`

	// 自定义响应配置失败响应示例。
	ResponseFailExample *string `json:"ResponseFailExample,omitnil,omitempty" name:"ResponseFailExample"`

	// API 的后端服务配置。
	ServiceConfig *ServiceConfig `json:"ServiceConfig,omitnil,omitempty" name:"ServiceConfig"`

	// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
	AuthRelationApiId *string `json:"AuthRelationApiId,omitnil,omitempty" name:"AuthRelationApiId"`

	// API的后端服务参数。
	ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitnil,omitempty" name:"ServiceParameters"`

	// oauth配置。当AuthType是OAUTH时生效。
	OauthConfig *OauthConfig `json:"OauthConfig,omitnil,omitempty" name:"OauthConfig"`

	// 用户自定义错误码配置。
	ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitnil,omitempty" name:"ResponseErrorCodes"`

	// 是否开启Base64编码,只有后端为scf时才会生效。
	IsBase64Encoded *bool `json:"IsBase64Encoded,omitnil,omitempty" name:"IsBase64Encoded"`

	// 是否开启Base64编码的header触发,只有后端为scf时才会生效。
	IsBase64Trigger *bool `json:"IsBase64Trigger,omitnil,omitempty" name:"IsBase64Trigger"`

	// Header触发规则,总规则数不能超过10。
	Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitnil,omitempty" name:"Base64EncodedTriggerRules"`

	// 事件总线ID。
	EventBusId *string `json:"EventBusId,omitnil,omitempty" name:"EventBusId"`

	// scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT),http直通云函数(HTTP)。
	ServiceScfFunctionType *string `json:"ServiceScfFunctionType,omitnil,omitempty" name:"ServiceScfFunctionType"`

	// 是否开启SCF Event异步调用。
	ServiceScfEventIsAsyncCall *bool `json:"ServiceScfEventIsAsyncCall,omitnil,omitempty" name:"ServiceScfEventIsAsyncCall"`

	// EIAM应用类型。
	EIAMAppType *string `json:"EIAMAppType,omitnil,omitempty" name:"EIAMAppType"`

	// EIAM应用认证类型,支持仅认证(AuthenticationOnly)、认证和鉴权(Authorization)。
	EIAMAuthType *string `json:"EIAMAuthType,omitnil,omitempty" name:"EIAMAuthType"`

	// EIAM应用Token 有效时间,单位为秒,默认为7200秒。
	EIAMAppId *string `json:"EIAMAppId,omitnil,omitempty" name:"EIAMAppId"`

	// EIAM应用ID。
	TokenTimeout *int64 `json:"TokenTimeout,omitnil,omitempty" name:"TokenTimeout"`
}

Predefined struct for user

type ModifyApiResponse

type ModifyApiResponse struct {
	*tchttp.BaseResponse
	Response *ModifyApiResponseParams `json:"Response"`
}

func NewModifyApiResponse

func NewModifyApiResponse() (response *ModifyApiResponse)

func (*ModifyApiResponse) FromJsonString

func (r *ModifyApiResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyApiResponse) ToJsonString

func (r *ModifyApiResponse) ToJsonString() string

type ModifyApiResponseParams added in v1.0.426

type ModifyApiResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyExclusiveInstanceRequest added in v1.0.288

type ModifyExclusiveInstanceRequest struct {
	*tchttp.BaseRequest

	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 独享实例name
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 独享实例描述
	InstanceDescription *string `json:"InstanceDescription,omitnil,omitempty" name:"InstanceDescription"`

	// 独享实例参数配置
	Parameters []*InstanceParameterInput `json:"Parameters,omitnil,omitempty" name:"Parameters"`
}

func NewModifyExclusiveInstanceRequest added in v1.0.288

func NewModifyExclusiveInstanceRequest() (request *ModifyExclusiveInstanceRequest)

func (*ModifyExclusiveInstanceRequest) FromJsonString added in v1.0.288

func (r *ModifyExclusiveInstanceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyExclusiveInstanceRequest) ToJsonString added in v1.0.288

func (r *ModifyExclusiveInstanceRequest) ToJsonString() string

type ModifyExclusiveInstanceRequestParams added in v1.0.426

type ModifyExclusiveInstanceRequestParams struct {
	// 独享实例唯一id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 独享实例name
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 独享实例描述
	InstanceDescription *string `json:"InstanceDescription,omitnil,omitempty" name:"InstanceDescription"`

	// 独享实例参数配置
	Parameters []*InstanceParameterInput `json:"Parameters,omitnil,omitempty" name:"Parameters"`
}

Predefined struct for user

type ModifyExclusiveInstanceResponse added in v1.0.288

type ModifyExclusiveInstanceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyExclusiveInstanceResponseParams `json:"Response"`
}

func NewModifyExclusiveInstanceResponse added in v1.0.288

func NewModifyExclusiveInstanceResponse() (response *ModifyExclusiveInstanceResponse)

func (*ModifyExclusiveInstanceResponse) FromJsonString added in v1.0.288

func (r *ModifyExclusiveInstanceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyExclusiveInstanceResponse) ToJsonString added in v1.0.288

func (r *ModifyExclusiveInstanceResponse) ToJsonString() string

type ModifyExclusiveInstanceResponseParams added in v1.0.426

type ModifyExclusiveInstanceResponseParams struct {
	// 独享实例详情信息
	Result *InstanceDetail `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyIPStrategyRequest

type ModifyIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 待修改的策略所属服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待修改的策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 待修改的策略详情。
	StrategyData *string `json:"StrategyData,omitnil,omitempty" name:"StrategyData"`
}

func NewModifyIPStrategyRequest

func NewModifyIPStrategyRequest() (request *ModifyIPStrategyRequest)

func (*ModifyIPStrategyRequest) FromJsonString

func (r *ModifyIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyIPStrategyRequest) ToJsonString

func (r *ModifyIPStrategyRequest) ToJsonString() string

type ModifyIPStrategyRequestParams added in v1.0.426

type ModifyIPStrategyRequestParams struct {
	// 待修改的策略所属服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待修改的策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 待修改的策略详情。
	StrategyData *string `json:"StrategyData,omitnil,omitempty" name:"StrategyData"`
}

Predefined struct for user

type ModifyIPStrategyResponse

type ModifyIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *ModifyIPStrategyResponseParams `json:"Response"`
}

func NewModifyIPStrategyResponse

func NewModifyIPStrategyResponse() (response *ModifyIPStrategyResponse)

func (*ModifyIPStrategyResponse) FromJsonString

func (r *ModifyIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyIPStrategyResponse) ToJsonString

func (r *ModifyIPStrategyResponse) ToJsonString() string

type ModifyIPStrategyResponseParams added in v1.0.426

type ModifyIPStrategyResponseParams struct {
	// 修改操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyPluginRequest added in v1.0.204

type ModifyPluginRequest struct {
	*tchttp.BaseRequest

	// 要修改的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要修改的API网关插件名称。最长50个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 要修改的插件描述,限定200字以内。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 要修改的插件定义语句,支持json。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`
}

func NewModifyPluginRequest added in v1.0.204

func NewModifyPluginRequest() (request *ModifyPluginRequest)

func (*ModifyPluginRequest) FromJsonString added in v1.0.204

func (r *ModifyPluginRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyPluginRequest) ToJsonString added in v1.0.204

func (r *ModifyPluginRequest) ToJsonString() string

type ModifyPluginRequestParams added in v1.0.426

type ModifyPluginRequestParams struct {
	// 要修改的插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 要修改的API网关插件名称。最长50个字符,支持 a-z,A-Z,0-9,_, 必须字母开头,字母或者数字结尾。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 要修改的插件描述,限定200字以内。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 要修改的插件定义语句,支持json。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`
}

Predefined struct for user

type ModifyPluginResponse added in v1.0.204

type ModifyPluginResponse struct {
	*tchttp.BaseResponse
	Response *ModifyPluginResponseParams `json:"Response"`
}

func NewModifyPluginResponse added in v1.0.204

func NewModifyPluginResponse() (response *ModifyPluginResponse)

func (*ModifyPluginResponse) FromJsonString added in v1.0.204

func (r *ModifyPluginResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyPluginResponse) ToJsonString added in v1.0.204

func (r *ModifyPluginResponse) ToJsonString() string

type ModifyPluginResponseParams added in v1.0.426

type ModifyPluginResponseParams struct {
	// 修改操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyServiceEnvironmentStrategyRequest

type ModifyServiceEnvironmentStrategyRequest struct {
	*tchttp.BaseRequest

	// 服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 限流值。
	Strategy *int64 `json:"Strategy,omitnil,omitempty" name:"Strategy"`

	// 环境列表。
	EnvironmentNames []*string `json:"EnvironmentNames,omitnil,omitempty" name:"EnvironmentNames"`
}

func NewModifyServiceEnvironmentStrategyRequest

func NewModifyServiceEnvironmentStrategyRequest() (request *ModifyServiceEnvironmentStrategyRequest)

func (*ModifyServiceEnvironmentStrategyRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyServiceEnvironmentStrategyRequest) ToJsonString

type ModifyServiceEnvironmentStrategyRequestParams added in v1.0.426

type ModifyServiceEnvironmentStrategyRequestParams struct {
	// 服务的唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 限流值。
	Strategy *int64 `json:"Strategy,omitnil,omitempty" name:"Strategy"`

	// 环境列表。
	EnvironmentNames []*string `json:"EnvironmentNames,omitnil,omitempty" name:"EnvironmentNames"`
}

Predefined struct for user

type ModifyServiceEnvironmentStrategyResponse

type ModifyServiceEnvironmentStrategyResponse struct {
	*tchttp.BaseResponse
	Response *ModifyServiceEnvironmentStrategyResponseParams `json:"Response"`
}

func NewModifyServiceEnvironmentStrategyResponse

func NewModifyServiceEnvironmentStrategyResponse() (response *ModifyServiceEnvironmentStrategyResponse)

func (*ModifyServiceEnvironmentStrategyResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyServiceEnvironmentStrategyResponse) ToJsonString

type ModifyServiceEnvironmentStrategyResponseParams added in v1.0.426

type ModifyServiceEnvironmentStrategyResponseParams struct {
	// 修改操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyServiceRequest

type ModifyServiceRequest struct {
	*tchttp.BaseRequest

	// 待修改服务的唯一 Id。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 修改后的服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 修改后的服务描述。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 修改后的服务前端请求类型,如 http、https和 http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// vpc属性,选择VPC后不可修改。为服务选择VPC后,可对接该VPC下的后端资源
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`
}

func NewModifyServiceRequest

func NewModifyServiceRequest() (request *ModifyServiceRequest)

func (*ModifyServiceRequest) FromJsonString

func (r *ModifyServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyServiceRequest) ToJsonString

func (r *ModifyServiceRequest) ToJsonString() string

type ModifyServiceRequestParams added in v1.0.426

type ModifyServiceRequestParams struct {
	// 待修改服务的唯一 Id。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 修改后的服务名称。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 修改后的服务描述。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 修改后的服务前端请求类型,如 http、https和 http&https。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// vpc属性,选择VPC后不可修改。为服务选择VPC后,可对接该VPC下的后端资源
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`
}

Predefined struct for user

type ModifyServiceResponse

type ModifyServiceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyServiceResponseParams `json:"Response"`
}

func NewModifyServiceResponse

func NewModifyServiceResponse() (response *ModifyServiceResponse)

func (*ModifyServiceResponse) FromJsonString

func (r *ModifyServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyServiceResponse) ToJsonString

func (r *ModifyServiceResponse) ToJsonString() string

type ModifyServiceResponseParams added in v1.0.426

type ModifyServiceResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifySubDomainRequest

type ModifySubDomainRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待修改路径映射的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 是否修改为使用默认路径映射。为 true,表示使用默认路径映射,为 false,表示使用自定义路径映射。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 证书 ID,协议包含 HTTPS 的时候要传该字段。
	CertificateId *string `json:"CertificateId,omitnil,omitempty" name:"CertificateId"`

	// 修改后的自定义域名协议类型。(http,https 或 http&https)
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 修改后的路径映射列表。
	PathMappingSet []*PathMapping `json:"PathMappingSet,omitnil,omitempty" name:"PathMappingSet"`

	// 网络类型 ('INNER' 或 'OUTER')
	NetType *string `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
	IsForcedHttps *bool `json:"IsForcedHttps,omitnil,omitempty" name:"IsForcedHttps"`
}

func NewModifySubDomainRequest

func NewModifySubDomainRequest() (request *ModifySubDomainRequest)

func (*ModifySubDomainRequest) FromJsonString

func (r *ModifySubDomainRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifySubDomainRequest) ToJsonString

func (r *ModifySubDomainRequest) ToJsonString() string

type ModifySubDomainRequestParams added in v1.0.426

type ModifySubDomainRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待修改路径映射的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`

	// 是否修改为使用默认路径映射。为 true,表示使用默认路径映射,为 false,表示使用自定义路径映射。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 证书 ID,协议包含 HTTPS 的时候要传该字段。
	CertificateId *string `json:"CertificateId,omitnil,omitempty" name:"CertificateId"`

	// 修改后的自定义域名协议类型。(http,https 或 http&https)
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 修改后的路径映射列表。
	PathMappingSet []*PathMapping `json:"PathMappingSet,omitnil,omitempty" name:"PathMappingSet"`

	// 网络类型 ('INNER' 或 'OUTER')
	NetType *string `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
	IsForcedHttps *bool `json:"IsForcedHttps,omitnil,omitempty" name:"IsForcedHttps"`
}

Predefined struct for user

type ModifySubDomainResponse

type ModifySubDomainResponse struct {
	*tchttp.BaseResponse
	Response *ModifySubDomainResponseParams `json:"Response"`
}

func NewModifySubDomainResponse

func NewModifySubDomainResponse() (response *ModifySubDomainResponse)

func (*ModifySubDomainResponse) FromJsonString

func (r *ModifySubDomainResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifySubDomainResponse) ToJsonString

func (r *ModifySubDomainResponse) ToJsonString() string

type ModifySubDomainResponseParams added in v1.0.426

type ModifySubDomainResponseParams struct {
	// 修改自定义域名操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyUpstreamRequest added in v1.0.357

type ModifyUpstreamRequest struct {
	*tchttp.BaseRequest

	// 后端通道唯一ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端协议,取值范围:HTTP, HTTPS
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 后端访问类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// 负载均衡算法,取值范围:ROUND_ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 请求重试次数,默认3次
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 网关转发到后端的 Host 请求头
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`

	// 后端节点列表
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 健康检查配置,目前只支持VPC通道
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// 容器服务配置
	K8sService []*K8sService `json:"K8sService,omitnil,omitempty" name:"K8sService"`
}

func NewModifyUpstreamRequest added in v1.0.357

func NewModifyUpstreamRequest() (request *ModifyUpstreamRequest)

func (*ModifyUpstreamRequest) FromJsonString added in v1.0.357

func (r *ModifyUpstreamRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUpstreamRequest) ToJsonString added in v1.0.357

func (r *ModifyUpstreamRequest) ToJsonString() string

type ModifyUpstreamRequestParams added in v1.0.426

type ModifyUpstreamRequestParams struct {
	// 后端通道唯一ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端协议,取值范围:HTTP, HTTPS
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 后端访问类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// 负载均衡算法,取值范围:ROUND_ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 请求重试次数,默认3次
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 网关转发到后端的 Host 请求头
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`

	// 后端节点列表
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 健康检查配置,目前只支持VPC通道
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// 容器服务配置
	K8sService []*K8sService `json:"K8sService,omitnil,omitempty" name:"K8sService"`
}

Predefined struct for user

type ModifyUpstreamResponse added in v1.0.357

type ModifyUpstreamResponse struct {
	*tchttp.BaseResponse
	Response *ModifyUpstreamResponseParams `json:"Response"`
}

func NewModifyUpstreamResponse added in v1.0.357

func NewModifyUpstreamResponse() (response *ModifyUpstreamResponse)

func (*ModifyUpstreamResponse) FromJsonString added in v1.0.357

func (r *ModifyUpstreamResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUpstreamResponse) ToJsonString added in v1.0.357

func (r *ModifyUpstreamResponse) ToJsonString() string

type ModifyUpstreamResponseParams added in v1.0.426

type ModifyUpstreamResponseParams struct {
	// 返回修改后的后端通道信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ModifyUpstreamResultInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyUpstreamResultInfo added in v1.0.672

type ModifyUpstreamResultInfo struct {
	// 后端通道唯一ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端协议,取值范围:HTTP, HTTPS
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 负载均衡算法,取值范围:ROUND_ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 请求重试次数
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 后端节点
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 创建时间
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 健康检查配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// 后端的类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// K8S容器服务配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	K8sServices []*K8sService `json:"K8sServices,omitnil,omitempty" name:"K8sServices"`

	// 网关转发给后端的Host请求头
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`
}

type ModifyUsagePlanRequest

type ModifyUsagePlanRequest struct {
	*tchttp.BaseRequest

	// 使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 修改后的用户自定义的使用计划名称。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 修改后的用户自定义的使用计划描述。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`
}

func NewModifyUsagePlanRequest

func NewModifyUsagePlanRequest() (request *ModifyUsagePlanRequest)

func (*ModifyUsagePlanRequest) FromJsonString

func (r *ModifyUsagePlanRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUsagePlanRequest) ToJsonString

func (r *ModifyUsagePlanRequest) ToJsonString() string

type ModifyUsagePlanRequestParams added in v1.0.426

type ModifyUsagePlanRequestParams struct {
	// 使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 修改后的用户自定义的使用计划名称。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 修改后的用户自定义的使用计划描述。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`
}

Predefined struct for user

type ModifyUsagePlanResponse

type ModifyUsagePlanResponse struct {
	*tchttp.BaseResponse
	Response *ModifyUsagePlanResponseParams `json:"Response"`
}

func NewModifyUsagePlanResponse

func NewModifyUsagePlanResponse() (response *ModifyUsagePlanResponse)

func (*ModifyUsagePlanResponse) FromJsonString

func (r *ModifyUsagePlanResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyUsagePlanResponse) ToJsonString

func (r *ModifyUsagePlanResponse) ToJsonString() string

type ModifyUsagePlanResponseParams added in v1.0.426

type ModifyUsagePlanResponseParams struct {
	// 使用计划详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *UsagePlanInfo `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type NetworkConfig added in v1.0.288

type NetworkConfig struct {
	// 最大出带宽
	InternetMaxBandwidthOut *int64 `json:"InternetMaxBandwidthOut,omitnil,omitempty" name:"InternetMaxBandwidthOut"`

	// EnableInternetInbound信息
	EnableInternetInbound *bool `json:"EnableInternetInbound,omitnil,omitempty" name:"EnableInternetInbound"`

	// EnableInternetOutbound信息
	EnableInternetOutbound *bool `json:"EnableInternetOutbound,omitnil,omitempty" name:"EnableInternetOutbound"`

	// InboundIpAddresses信息
	InboundIpAddresses []*string `json:"InboundIpAddresses,omitnil,omitempty" name:"InboundIpAddresses"`

	// OutboundIpAddresses信息
	OutboundIpAddresses []*string `json:"OutboundIpAddresses,omitnil,omitempty" name:"OutboundIpAddresses"`
}

type OauthConfig

type OauthConfig struct {
	// 公钥,用于验证用户token。
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// token传递位置。
	TokenLocation *string `json:"TokenLocation,omitnil,omitempty" name:"TokenLocation"`

	// 重定向地址,用于引导用户登录操作。
	LoginRedirectUrl *string `json:"LoginRedirectUrl,omitnil,omitempty" name:"LoginRedirectUrl"`
}

type ParameterInfo added in v1.0.288

type ParameterInfo struct {
	// 名字
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 当前值
	Value *int64 `json:"Value,omitnil,omitempty" name:"Value"`

	// 默认值
	Default *int64 `json:"Default,omitnil,omitempty" name:"Default"`

	// 单位
	Unit *string `json:"Unit,omitnil,omitempty" name:"Unit"`

	// 类型, integer|string
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 最小
	Minimum *int64 `json:"Minimum,omitnil,omitempty" name:"Minimum"`

	// 最大
	Maximum *int64 `json:"Maximum,omitnil,omitempty" name:"Maximum"`

	// 修改时间
	//
	// Deprecated: ModifedTime is deprecated.
	ModifedTime *string `json:"ModifedTime,omitnil,omitempty" name:"ModifedTime"`

	// 字符类型的值,当Type为string时才有意义
	// 注意:此字段可能返回 null,表示取不到有效值。
	ValueString *string `json:"ValueString,omitnil,omitempty" name:"ValueString"`

	// 字符类型的默认值,当Type为string时才有意义
	// 注意:此字段可能返回 null,表示取不到有效值。
	DefaultValueString *string `json:"DefaultValueString,omitnil,omitempty" name:"DefaultValueString"`

	// 可调整范围
	// 注意:此字段可能返回 null,表示取不到有效值。
	Range *string `json:"Range,omitnil,omitempty" name:"Range"`
}

type PathMapping

type PathMapping struct {
	// 路径。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// 发布环境,可选值为“test”、 ”prepub“、”release“。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`
}

type Plugin

type Plugin struct {
	// 插件ID。
	PluginId *string `json:"PluginId,omitnil,omitempty" name:"PluginId"`

	// 插件名称。
	PluginName *string `json:"PluginName,omitnil,omitempty" name:"PluginName"`

	// 插件类型。
	PluginType *string `json:"PluginType,omitnil,omitempty" name:"PluginType"`

	// 插件定义语句。
	PluginData *string `json:"PluginData,omitnil,omitempty" name:"PluginData"`

	// 插件描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 插件创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 插件修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 插件绑定的API总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AttachedApiTotalCount *int64 `json:"AttachedApiTotalCount,omitnil,omitempty" name:"AttachedApiTotalCount"`

	// 插件绑定的API信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AttachedApis []*AttachedApiInfo `json:"AttachedApis,omitnil,omitempty" name:"AttachedApis"`
}

type PluginSummary

type PluginSummary struct {
	// 插件个数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 插件详情。
	PluginSet []*Plugin `json:"PluginSet,omitnil,omitempty" name:"PluginSet"`
}

type ReleaseService

type ReleaseService struct {
	// 发布时的备注信息填写。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReleaseDesc *string `json:"ReleaseDesc,omitnil,omitempty" name:"ReleaseDesc"`

	// 发布的版本id。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReleaseVersion *string `json:"ReleaseVersion,omitnil,omitempty" name:"ReleaseVersion"`
}

type ReleaseServiceRequest

type ReleaseServiceRequest struct {
	*tchttp.BaseRequest

	// 待发布服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待发布的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 本次的发布描述。
	ReleaseDesc *string `json:"ReleaseDesc,omitnil,omitempty" name:"ReleaseDesc"`

	// apiId列表,预留字段,默认全量api发布。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewReleaseServiceRequest

func NewReleaseServiceRequest() (request *ReleaseServiceRequest)

func (*ReleaseServiceRequest) FromJsonString

func (r *ReleaseServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ReleaseServiceRequest) ToJsonString

func (r *ReleaseServiceRequest) ToJsonString() string

type ReleaseServiceRequestParams added in v1.0.426

type ReleaseServiceRequestParams struct {
	// 待发布服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待发布的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 本次的发布描述。
	ReleaseDesc *string `json:"ReleaseDesc,omitnil,omitempty" name:"ReleaseDesc"`

	// apiId列表,预留字段,默认全量api发布。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type ReleaseServiceResponse

type ReleaseServiceResponse struct {
	*tchttp.BaseResponse
	Response *ReleaseServiceResponseParams `json:"Response"`
}

func NewReleaseServiceResponse

func NewReleaseServiceResponse() (response *ReleaseServiceResponse)

func (*ReleaseServiceResponse) FromJsonString

func (r *ReleaseServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ReleaseServiceResponse) ToJsonString

func (r *ReleaseServiceResponse) ToJsonString() string

type ReleaseServiceResponseParams added in v1.0.426

type ReleaseServiceResponseParams struct {
	// 发布信息。
	Result *ReleaseService `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ReqParameter

type ReqParameter struct {
	// API 的前端参数名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// API 的前端参数位置,如 header。目前支持 header、query、path。
	Position *string `json:"Position,omitnil,omitempty" name:"Position"`

	// API 的前端参数类型,如 String、int。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// API 的前端参数默认值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// API 的前端参数是否必填,True:表示必填,False:表示可选。
	Required *bool `json:"Required,omitnil,omitempty" name:"Required"`

	// API 的前端参数备注。
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`
}

type RequestConfig

type RequestConfig struct {
	// API 的路径,如 /path。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 的请求方法,如 GET。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`
}

type RequestParameter

type RequestParameter struct {
	// 请求参数名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 描述
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// 参数位置
	Position *string `json:"Position,omitnil,omitempty" name:"Position"`

	// 参数类型
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 默认值
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 是否必须
	Required *bool `json:"Required,omitnil,omitempty" name:"Required"`
}

type ResetAPIDocPasswordRequest

type ResetAPIDocPasswordRequest struct {
	*tchttp.BaseRequest

	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

func NewResetAPIDocPasswordRequest

func NewResetAPIDocPasswordRequest() (request *ResetAPIDocPasswordRequest)

func (*ResetAPIDocPasswordRequest) FromJsonString

func (r *ResetAPIDocPasswordRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ResetAPIDocPasswordRequest) ToJsonString

func (r *ResetAPIDocPasswordRequest) ToJsonString() string

type ResetAPIDocPasswordRequestParams added in v1.0.426

type ResetAPIDocPasswordRequestParams struct {
	// API文档ID
	ApiDocId *string `json:"ApiDocId,omitnil,omitempty" name:"ApiDocId"`
}

Predefined struct for user

type ResetAPIDocPasswordResponse

type ResetAPIDocPasswordResponse struct {
	*tchttp.BaseResponse
	Response *ResetAPIDocPasswordResponseParams `json:"Response"`
}

func NewResetAPIDocPasswordResponse

func NewResetAPIDocPasswordResponse() (response *ResetAPIDocPasswordResponse)

func (*ResetAPIDocPasswordResponse) FromJsonString

func (r *ResetAPIDocPasswordResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ResetAPIDocPasswordResponse) ToJsonString

func (r *ResetAPIDocPasswordResponse) ToJsonString() string

type ResetAPIDocPasswordResponseParams added in v1.0.426

type ResetAPIDocPasswordResponseParams struct {
	// API文档基本信息
	Result *APIDoc `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ResponseErrorCodeReq

type ResponseErrorCodeReq struct {
	// 自定义响应配置错误码。
	Code *int64 `json:"Code,omitnil,omitempty" name:"Code"`

	// 自定义响应配置错误信息。
	Msg *string `json:"Msg,omitnil,omitempty" name:"Msg"`

	// 自定义响应配置错误码备注。
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`

	// 自定义错误码转换。
	ConvertedCode *int64 `json:"ConvertedCode,omitnil,omitempty" name:"ConvertedCode"`

	// 是否需要开启错误码转换。
	NeedConvert *bool `json:"NeedConvert,omitnil,omitempty" name:"NeedConvert"`
}

type Service

type Service struct {
	// 内网访问https端口。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InnerHttpsPort *int64 `json:"InnerHttpsPort,omitnil,omitempty" name:"InnerHttpsPort"`

	// 用户自定义的服务描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceDesc *string `json:"ServiceDesc,omitnil,omitempty" name:"ServiceDesc"`

	// 服务的前端请求类型。如http、https 或者 http&https。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Protocol *string `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 服务支持的网络类型。
	// 注意:此字段可能返回 null,表示取不到有效值。
	NetTypes []*string `json:"NetTypes,omitnil,omitempty" name:"NetTypes"`

	// 独占集群名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ExclusiveSetName *string `json:"ExclusiveSetName,omitnil,omitempty" name:"ExclusiveSetName"`

	// 服务唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// IP版本。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IpVersion *string `json:"IpVersion,omitnil,omitempty" name:"IpVersion"`

	// 已经发布的环境列表。如test、prepub、release。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AvailableEnvironments []*string `json:"AvailableEnvironments,omitnil,omitempty" name:"AvailableEnvironments"`

	// 用户自定义的服务名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// 系统为该服务分配的外网域名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	OuterSubDomain *string `json:"OuterSubDomain,omitnil,omitempty" name:"OuterSubDomain"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 内网访问http端口。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InnerHttpPort *uint64 `json:"InnerHttpPort,omitnil,omitempty" name:"InnerHttpPort"`

	// 系统为该服务自动分配的内网域名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InnerSubDomain *string `json:"InnerSubDomain,omitnil,omitempty" name:"InnerSubDomain"`

	// 服务的计费状态。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TradeIsolateStatus *int64 `json:"TradeIsolateStatus,omitnil,omitempty" name:"TradeIsolateStatus"`

	// 服务绑定的标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 独享实例
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 集群类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	SetType *string `json:"SetType,omitnil,omitempty" name:"SetType"`

	// 服务部署的集群类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	DeploymentType *string `json:"DeploymentType,omitnil,omitempty" name:"DeploymentType"`
}

type ServiceConfig

type ServiceConfig struct {
	// 后端类型。启用vpc时生效,目前支持的类型为clb, cvm和upstream
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// vpc 的唯一ID。
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// API 的后端服务url。如果ServiceType是HTTP,则此参数必传。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// API 的后端服务路径,如 /path。如果 ServiceType 是 HTTP,则此参数必传。前后端路径可不同。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API的后端服务请求方法,如 GET。如果 ServiceType 是 HTTP,则此参数必传。前后端方法可不同。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 当绑定vpc通道才需要
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// API后端COS配置。如果 ServiceType 是 COS,则此参数必传。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CosConfig *CosConfig `json:"CosConfig,omitnil,omitempty" name:"CosConfig"`
}

type ServiceEnvironmentSet

type ServiceEnvironmentSet struct {
	// 服务绑定环境总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 服务绑定环境列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnvironmentList []*Environment `json:"EnvironmentList,omitnil,omitempty" name:"EnvironmentList"`
}

type ServiceEnvironmentStrategy

type ServiceEnvironmentStrategy struct {
	// 环境名。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 访问服务对应环境的url。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 发布状态。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 发布的版本号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 限流值。
	Strategy *int64 `json:"Strategy,omitnil,omitempty" name:"Strategy"`

	// 最大限流值
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxStrategy *int64 `json:"MaxStrategy,omitnil,omitempty" name:"MaxStrategy"`
}

type ServiceEnvironmentStrategyStatus

type ServiceEnvironmentStrategyStatus struct {
	// 限流策略数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 限流策略列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnvironmentList []*ServiceEnvironmentStrategy `json:"EnvironmentList,omitnil,omitempty" name:"EnvironmentList"`
}

type ServiceParameter

type ServiceParameter struct {
	// API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// API 的后端服务参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Position *string `json:"Position,omitnil,omitempty" name:"Position"`

	// API 的后端服务参数对应的前端参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterPosition *string `json:"RelevantRequestParameterPosition,omitnil,omitempty" name:"RelevantRequestParameterPosition"`

	// API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterName *string `json:"RelevantRequestParameterName,omitnil,omitempty" name:"RelevantRequestParameterName"`

	// API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterDesc *string `json:"RelevantRequestParameterDesc,omitnil,omitempty" name:"RelevantRequestParameterDesc"`

	// API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RelevantRequestParameterType *string `json:"RelevantRequestParameterType,omitnil,omitempty" name:"RelevantRequestParameterType"`
}

type ServiceReleaseHistory

type ServiceReleaseHistory struct {
	// 发布版本总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 历史版本列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionList []*ServiceReleaseHistoryInfo `json:"VersionList,omitnil,omitempty" name:"VersionList"`
}

type ServiceReleaseHistoryInfo

type ServiceReleaseHistoryInfo struct {
	// 版本号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 版本描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionDesc *string `json:"VersionDesc,omitnil,omitempty" name:"VersionDesc"`

	// 版本发布时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReleaseTime *string `json:"ReleaseTime,omitnil,omitempty" name:"ReleaseTime"`
}

type ServiceReleaseVersion

type ServiceReleaseVersion struct {
	// 发布版本总数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 发布版本列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	VersionList []*DescribeServiceReleaseVersionResultVersionListInfo `json:"VersionList,omitnil,omitempty" name:"VersionList"`
}

type ServiceSubDomainMappings

type ServiceSubDomainMappings struct {
	// 是否使用默认路径映射,为 True 表示使用默认路径映射;为 False 的话,表示使用自定义路径映射,此时 PathMappingSet 不为空。
	IsDefaultMapping *bool `json:"IsDefaultMapping,omitnil,omitempty" name:"IsDefaultMapping"`

	// 自定义路径映射列表。
	PathMappingSet []*PathMapping `json:"PathMappingSet,omitnil,omitempty" name:"PathMappingSet"`
}

type ServiceUsagePlanSet

type ServiceUsagePlanSet struct {
	// 服务上绑定的使用计划总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 服务上绑定的使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceUsagePlanList []*ApiUsagePlan `json:"ServiceUsagePlanList,omitnil,omitempty" name:"ServiceUsagePlanList"`
}

type ServicesStatus

type ServicesStatus struct {
	// 服务列表总数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 服务列表详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceSet []*Service `json:"ServiceSet,omitnil,omitempty" name:"ServiceSet"`
}

type Tag

type Tag struct {
	// 标签的 key。
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

	// 便签的 value。
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type TargetServicesReq

type TargetServicesReq struct {
	// vm ip
	VmIp *string `json:"VmIp,omitnil,omitempty" name:"VmIp"`

	// vpc id
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// vm port
	VmPort *int64 `json:"VmPort,omitnil,omitempty" name:"VmPort"`

	// cvm所在宿主机ip
	HostIp *string `json:"HostIp,omitnil,omitempty" name:"HostIp"`

	// docker ip
	DockerIp *string `json:"DockerIp,omitnil,omitempty" name:"DockerIp"`
}

type TsfLoadBalanceConfResp

type TsfLoadBalanceConfResp struct {
	// 是否开启负载均衡。
	// 注意:此字段可能返回 null,表示取不到有效值。
	IsLoadBalance *bool `json:"IsLoadBalance,omitnil,omitempty" name:"IsLoadBalance"`

	// 负载均衡方式。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 是否开启会话保持。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SessionStickRequired *bool `json:"SessionStickRequired,omitnil,omitempty" name:"SessionStickRequired"`

	// 会话保持超时时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SessionStickTimeout *int64 `json:"SessionStickTimeout,omitnil,omitempty" name:"SessionStickTimeout"`
}

type UnBindEnvironmentRequest

type UnBindEnvironmentRequest struct {
	*tchttp.BaseRequest

	// 绑定类型,取值为 API、SERVICE,默认值为 SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 待绑定的使用计划唯一 ID 列表。
	UsagePlanIds []*string `json:"UsagePlanIds,omitnil,omitempty" name:"UsagePlanIds"`

	// 待解绑的服务环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待解绑的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 唯一 ID 数组,当 BindType=API 时,需要传入此参数。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewUnBindEnvironmentRequest

func NewUnBindEnvironmentRequest() (request *UnBindEnvironmentRequest)

func (*UnBindEnvironmentRequest) FromJsonString

func (r *UnBindEnvironmentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindEnvironmentRequest) ToJsonString

func (r *UnBindEnvironmentRequest) ToJsonString() string

type UnBindEnvironmentRequestParams added in v1.0.426

type UnBindEnvironmentRequestParams struct {
	// 绑定类型,取值为 API、SERVICE,默认值为 SERVICE。
	BindType *string `json:"BindType,omitnil,omitempty" name:"BindType"`

	// 待绑定的使用计划唯一 ID 列表。
	UsagePlanIds []*string `json:"UsagePlanIds,omitnil,omitempty" name:"UsagePlanIds"`

	// 待解绑的服务环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待解绑的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 唯一 ID 数组,当 BindType=API 时,需要传入此参数。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type UnBindEnvironmentResponse

type UnBindEnvironmentResponse struct {
	*tchttp.BaseResponse
	Response *UnBindEnvironmentResponseParams `json:"Response"`
}

func NewUnBindEnvironmentResponse

func NewUnBindEnvironmentResponse() (response *UnBindEnvironmentResponse)

func (*UnBindEnvironmentResponse) FromJsonString

func (r *UnBindEnvironmentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindEnvironmentResponse) ToJsonString

func (r *UnBindEnvironmentResponse) ToJsonString() string

type UnBindEnvironmentResponseParams added in v1.0.426

type UnBindEnvironmentResponseParams struct {
	// 解绑操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnBindIPStrategyRequest

type UnBindIPStrategyRequest struct {
	*tchttp.BaseRequest

	// 待解绑的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待解绑的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 待解绑的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 待解绑的 API 列表。
	UnBindApiIds []*string `json:"UnBindApiIds,omitnil,omitempty" name:"UnBindApiIds"`
}

func NewUnBindIPStrategyRequest

func NewUnBindIPStrategyRequest() (request *UnBindIPStrategyRequest)

func (*UnBindIPStrategyRequest) FromJsonString

func (r *UnBindIPStrategyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindIPStrategyRequest) ToJsonString

func (r *UnBindIPStrategyRequest) ToJsonString() string

type UnBindIPStrategyRequestParams added in v1.0.426

type UnBindIPStrategyRequestParams struct {
	// 待解绑的服务唯一ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待解绑的IP策略唯一ID。
	StrategyId *string `json:"StrategyId,omitnil,omitempty" name:"StrategyId"`

	// 待解绑的环境。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 待解绑的 API 列表。
	UnBindApiIds []*string `json:"UnBindApiIds,omitnil,omitempty" name:"UnBindApiIds"`
}

Predefined struct for user

type UnBindIPStrategyResponse

type UnBindIPStrategyResponse struct {
	*tchttp.BaseResponse
	Response *UnBindIPStrategyResponseParams `json:"Response"`
}

func NewUnBindIPStrategyResponse

func NewUnBindIPStrategyResponse() (response *UnBindIPStrategyResponse)

func (*UnBindIPStrategyResponse) FromJsonString

func (r *UnBindIPStrategyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindIPStrategyResponse) ToJsonString

func (r *UnBindIPStrategyResponse) ToJsonString() string

type UnBindIPStrategyResponseParams added in v1.0.426

type UnBindIPStrategyResponseParams struct {
	// 解绑操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnBindSecretIdsRequest

type UnBindSecretIdsRequest struct {
	*tchttp.BaseRequest

	// 待解绑的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待解绑的密钥 ID 数组。
	AccessKeyIds []*string `json:"AccessKeyIds,omitnil,omitempty" name:"AccessKeyIds"`
}

func NewUnBindSecretIdsRequest

func NewUnBindSecretIdsRequest() (request *UnBindSecretIdsRequest)

func (*UnBindSecretIdsRequest) FromJsonString

func (r *UnBindSecretIdsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindSecretIdsRequest) ToJsonString

func (r *UnBindSecretIdsRequest) ToJsonString() string

type UnBindSecretIdsRequestParams added in v1.0.426

type UnBindSecretIdsRequestParams struct {
	// 待解绑的使用计划唯一 ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 待解绑的密钥 ID 数组。
	AccessKeyIds []*string `json:"AccessKeyIds,omitnil,omitempty" name:"AccessKeyIds"`
}

Predefined struct for user

type UnBindSecretIdsResponse

type UnBindSecretIdsResponse struct {
	*tchttp.BaseResponse
	Response *UnBindSecretIdsResponseParams `json:"Response"`
}

func NewUnBindSecretIdsResponse

func NewUnBindSecretIdsResponse() (response *UnBindSecretIdsResponse)

func (*UnBindSecretIdsResponse) FromJsonString

func (r *UnBindSecretIdsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindSecretIdsResponse) ToJsonString

func (r *UnBindSecretIdsResponse) ToJsonString() string

type UnBindSecretIdsResponseParams added in v1.0.426

type UnBindSecretIdsResponseParams struct {
	// 解绑操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnBindSubDomainRequest

type UnBindSubDomainRequest struct {
	*tchttp.BaseRequest

	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待解绑的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`
}

func NewUnBindSubDomainRequest

func NewUnBindSubDomainRequest() (request *UnBindSubDomainRequest)

func (*UnBindSubDomainRequest) FromJsonString

func (r *UnBindSubDomainRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindSubDomainRequest) ToJsonString

func (r *UnBindSubDomainRequest) ToJsonString() string

type UnBindSubDomainRequestParams added in v1.0.426

type UnBindSubDomainRequestParams struct {
	// 服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待解绑的自定义的域名。
	SubDomain *string `json:"SubDomain,omitnil,omitempty" name:"SubDomain"`
}

Predefined struct for user

type UnBindSubDomainResponse

type UnBindSubDomainResponse struct {
	*tchttp.BaseResponse
	Response *UnBindSubDomainResponseParams `json:"Response"`
}

func NewUnBindSubDomainResponse

func NewUnBindSubDomainResponse() (response *UnBindSubDomainResponse)

func (*UnBindSubDomainResponse) FromJsonString

func (r *UnBindSubDomainResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnBindSubDomainResponse) ToJsonString

func (r *UnBindSubDomainResponse) ToJsonString() string

type UnBindSubDomainResponseParams added in v1.0.426

type UnBindSubDomainResponseParams struct {
	// 解绑自定义域名操作是否成功。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnReleaseServiceRequest

type UnReleaseServiceRequest struct {
	*tchttp.BaseRequest

	// 待下线服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待下线的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 保留字段,待下线的API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

func NewUnReleaseServiceRequest

func NewUnReleaseServiceRequest() (request *UnReleaseServiceRequest)

func (*UnReleaseServiceRequest) FromJsonString

func (r *UnReleaseServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnReleaseServiceRequest) ToJsonString

func (r *UnReleaseServiceRequest) ToJsonString() string

type UnReleaseServiceRequestParams added in v1.0.426

type UnReleaseServiceRequestParams struct {
	// 待下线服务的唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待下线的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 保留字段,待下线的API列表。
	ApiIds []*string `json:"ApiIds,omitnil,omitempty" name:"ApiIds"`
}

Predefined struct for user

type UnReleaseServiceResponse

type UnReleaseServiceResponse struct {
	*tchttp.BaseResponse
	Response *UnReleaseServiceResponseParams `json:"Response"`
}

func NewUnReleaseServiceResponse

func NewUnReleaseServiceResponse() (response *UnReleaseServiceResponse)

func (*UnReleaseServiceResponse) FromJsonString

func (r *UnReleaseServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnReleaseServiceResponse) ToJsonString

func (r *UnReleaseServiceResponse) ToJsonString() string

type UnReleaseServiceResponseParams added in v1.0.426

type UnReleaseServiceResponseParams struct {
	// 下线操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UnbindApiAppRequest added in v1.0.209

type UnbindApiAppRequest struct {
	*tchttp.BaseRequest

	// 待绑定的应用唯一 ID 。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

func NewUnbindApiAppRequest added in v1.0.209

func NewUnbindApiAppRequest() (request *UnbindApiAppRequest)

func (*UnbindApiAppRequest) FromJsonString added in v1.0.209

func (r *UnbindApiAppRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindApiAppRequest) ToJsonString added in v1.0.209

func (r *UnbindApiAppRequest) ToJsonString() string

type UnbindApiAppRequestParams added in v1.0.426

type UnbindApiAppRequestParams struct {
	// 待绑定的应用唯一 ID 。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 待绑定的环境。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 待绑定的服务唯一 ID。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待绑定的API唯一ID。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`
}

Predefined struct for user

type UnbindApiAppResponse added in v1.0.209

type UnbindApiAppResponse struct {
	*tchttp.BaseResponse
	Response *UnbindApiAppResponseParams `json:"Response"`
}

func NewUnbindApiAppResponse added in v1.0.209

func NewUnbindApiAppResponse() (response *UnbindApiAppResponse)

func (*UnbindApiAppResponse) FromJsonString added in v1.0.209

func (r *UnbindApiAppResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindApiAppResponse) ToJsonString added in v1.0.209

func (r *UnbindApiAppResponse) ToJsonString() string

type UnbindApiAppResponseParams added in v1.0.426

type UnbindApiAppResponseParams struct {
	// 解除绑定操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateApiAppKeyRequest added in v1.0.209

type UpdateApiAppKeyRequest struct {
	*tchttp.BaseRequest

	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 应用的Key。
	ApiAppKey *string `json:"ApiAppKey,omitnil,omitempty" name:"ApiAppKey"`

	// 应用的Secret。
	ApiAppSecret *string `json:"ApiAppSecret,omitnil,omitempty" name:"ApiAppSecret"`
}

func NewUpdateApiAppKeyRequest added in v1.0.209

func NewUpdateApiAppKeyRequest() (request *UpdateApiAppKeyRequest)

func (*UpdateApiAppKeyRequest) FromJsonString added in v1.0.209

func (r *UpdateApiAppKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateApiAppKeyRequest) ToJsonString added in v1.0.209

func (r *UpdateApiAppKeyRequest) ToJsonString() string

type UpdateApiAppKeyRequestParams added in v1.0.426

type UpdateApiAppKeyRequestParams struct {
	// 应用唯一 ID。
	ApiAppId *string `json:"ApiAppId,omitnil,omitempty" name:"ApiAppId"`

	// 应用的Key。
	ApiAppKey *string `json:"ApiAppKey,omitnil,omitempty" name:"ApiAppKey"`

	// 应用的Secret。
	ApiAppSecret *string `json:"ApiAppSecret,omitnil,omitempty" name:"ApiAppSecret"`
}

Predefined struct for user

type UpdateApiAppKeyResponse added in v1.0.209

type UpdateApiAppKeyResponse struct {
	*tchttp.BaseResponse
	Response *UpdateApiAppKeyResponseParams `json:"Response"`
}

func NewUpdateApiAppKeyResponse added in v1.0.209

func NewUpdateApiAppKeyResponse() (response *UpdateApiAppKeyResponse)

func (*UpdateApiAppKeyResponse) FromJsonString added in v1.0.209

func (r *UpdateApiAppKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateApiAppKeyResponse) ToJsonString added in v1.0.209

func (r *UpdateApiAppKeyResponse) ToJsonString() string

type UpdateApiAppKeyResponseParams added in v1.0.426

type UpdateApiAppKeyResponseParams struct {
	// 更新操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateApiKeyRequest

type UpdateApiKeyRequest struct {
	*tchttp.BaseRequest

	// 待更换的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 待更换的密钥 Key,更新自定义密钥时,该字段为必传。长度10 - 50字符,包括字母、数字、英文下划线。
	AccessKeySecret *string `json:"AccessKeySecret,omitnil,omitempty" name:"AccessKeySecret"`
}

func NewUpdateApiKeyRequest

func NewUpdateApiKeyRequest() (request *UpdateApiKeyRequest)

func (*UpdateApiKeyRequest) FromJsonString

func (r *UpdateApiKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateApiKeyRequest) ToJsonString

func (r *UpdateApiKeyRequest) ToJsonString() string

type UpdateApiKeyRequestParams added in v1.0.426

type UpdateApiKeyRequestParams struct {
	// 待更换的密钥 ID。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 待更换的密钥 Key,更新自定义密钥时,该字段为必传。长度10 - 50字符,包括字母、数字、英文下划线。
	AccessKeySecret *string `json:"AccessKeySecret,omitnil,omitempty" name:"AccessKeySecret"`
}

Predefined struct for user

type UpdateApiKeyResponse

type UpdateApiKeyResponse struct {
	*tchttp.BaseResponse
	Response *UpdateApiKeyResponseParams `json:"Response"`
}

func NewUpdateApiKeyResponse

func NewUpdateApiKeyResponse() (response *UpdateApiKeyResponse)

func (*UpdateApiKeyResponse) FromJsonString

func (r *UpdateApiKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateApiKeyResponse) ToJsonString

func (r *UpdateApiKeyResponse) ToJsonString() string

type UpdateApiKeyResponseParams added in v1.0.426

type UpdateApiKeyResponseParams struct {
	// 更换后的密钥详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *ApiKey `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateServiceRequest

type UpdateServiceRequest struct {
	*tchttp.BaseRequest

	// 待切换服务的唯一 Id。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待切换的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 切换的版本号。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 本次的切换描述。
	UpdateDesc *string `json:"UpdateDesc,omitnil,omitempty" name:"UpdateDesc"`
}

func NewUpdateServiceRequest

func NewUpdateServiceRequest() (request *UpdateServiceRequest)

func (*UpdateServiceRequest) FromJsonString

func (r *UpdateServiceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateServiceRequest) ToJsonString

func (r *UpdateServiceRequest) ToJsonString() string

type UpdateServiceRequestParams added in v1.0.426

type UpdateServiceRequestParams struct {
	// 待切换服务的唯一 Id。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// 待切换的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 切换的版本号。
	VersionName *string `json:"VersionName,omitnil,omitempty" name:"VersionName"`

	// 本次的切换描述。
	UpdateDesc *string `json:"UpdateDesc,omitnil,omitempty" name:"UpdateDesc"`
}

Predefined struct for user

type UpdateServiceResponse

type UpdateServiceResponse struct {
	*tchttp.BaseResponse
	Response *UpdateServiceResponseParams `json:"Response"`
}

func NewUpdateServiceResponse

func NewUpdateServiceResponse() (response *UpdateServiceResponse)

func (*UpdateServiceResponse) FromJsonString

func (r *UpdateServiceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateServiceResponse) ToJsonString

func (r *UpdateServiceResponse) ToJsonString() string

type UpdateServiceResponseParams added in v1.0.426

type UpdateServiceResponseParams struct {
	// 切换版本操作是否成功。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Result *bool `json:"Result,omitnil,omitempty" name:"Result"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpstreamHealthChecker added in v1.0.357

type UpstreamHealthChecker struct {
	// 标识是否开启主动健康检查。
	EnableActiveCheck *bool `json:"EnableActiveCheck,omitnil,omitempty" name:"EnableActiveCheck"`

	// 标识是否开启被动健康检查。
	EnablePassiveCheck *bool `json:"EnablePassiveCheck,omitnil,omitempty" name:"EnablePassiveCheck"`

	// 健康检查时,判断为成功请求的 HTTP 状态码。
	HealthyHttpStatus *string `json:"HealthyHttpStatus,omitnil,omitempty" name:"HealthyHttpStatus"`

	// 健康检查时,判断为失败请求的 HTTP 状态码。
	UnhealthyHttpStatus *string `json:"UnhealthyHttpStatus,omitnil,omitempty" name:"UnhealthyHttpStatus"`

	// TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。
	TcpFailureThreshold *uint64 `json:"TcpFailureThreshold,omitnil,omitempty" name:"TcpFailureThreshold"`

	// 连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。
	TimeoutThreshold *uint64 `json:"TimeoutThreshold,omitnil,omitempty" name:"TimeoutThreshold"`

	// HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。
	HttpFailureThreshold *uint64 `json:"HttpFailureThreshold,omitnil,omitempty" name:"HttpFailureThreshold"`

	// 主动健康检查时探测请求的路径。默认为"/"。
	ActiveCheckHttpPath *string `json:"ActiveCheckHttpPath,omitnil,omitempty" name:"ActiveCheckHttpPath"`

	// 主动健康检查的探测请求超时,单位秒。默认为5秒。
	ActiveCheckTimeout *uint64 `json:"ActiveCheckTimeout,omitnil,omitempty" name:"ActiveCheckTimeout"`

	// 主动健康检查的时间间隔,默认5秒。
	ActiveCheckInterval *uint64 `json:"ActiveCheckInterval,omitnil,omitempty" name:"ActiveCheckInterval"`

	// 主动健康检查时探测请求的的请求头。
	ActiveRequestHeader []*UpstreamHealthCheckerReqHeaders `json:"ActiveRequestHeader,omitnil,omitempty" name:"ActiveRequestHeader"`

	// 异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。
	UnhealthyTimeout *uint64 `json:"UnhealthyTimeout,omitnil,omitempty" name:"UnhealthyTimeout"`
}

type UpstreamHealthCheckerReqHeaders added in v1.0.357

type UpstreamHealthCheckerReqHeaders struct {
}

type UpstreamInfo added in v1.0.357

type UpstreamInfo struct {
	// 后端通道唯一ID
	UpstreamId *string `json:"UpstreamId,omitnil,omitempty" name:"UpstreamId"`

	// 后端通道名字
	UpstreamName *string `json:"UpstreamName,omitnil,omitempty" name:"UpstreamName"`

	// 后端通道描述
	UpstreamDescription *string `json:"UpstreamDescription,omitnil,omitempty" name:"UpstreamDescription"`

	// 后端协议,取值范围:HTTP, HTTPS
	Scheme *string `json:"Scheme,omitnil,omitempty" name:"Scheme"`

	// 负载均衡算法,取值范围:ROUND_ROBIN
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// VPC唯一ID
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// 请求重试次数
	Retries *uint64 `json:"Retries,omitnil,omitempty" name:"Retries"`

	// 后端节点
	Nodes []*UpstreamNode `json:"Nodes,omitnil,omitempty" name:"Nodes"`

	// 创建时间
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 健康检查配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	HealthChecker *UpstreamHealthChecker `json:"HealthChecker,omitnil,omitempty" name:"HealthChecker"`

	// 后端的类型,取值范围:IP_PORT, K8S
	UpstreamType *string `json:"UpstreamType,omitnil,omitempty" name:"UpstreamType"`

	// K8S容器服务配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	K8sServices []*K8sService `json:"K8sServices,omitnil,omitempty" name:"K8sServices"`

	// 网关转发给后端的Host请求头
	// 注意:此字段可能返回 null,表示取不到有效值。
	UpstreamHost *string `json:"UpstreamHost,omitnil,omitempty" name:"UpstreamHost"`
}

type UpstreamNode added in v1.0.357

type UpstreamNode struct {
	// IP或域名
	Host *string `json:"Host,omitnil,omitempty" name:"Host"`

	// 端口[0, 65535]
	Port *uint64 `json:"Port,omitnil,omitempty" name:"Port"`

	// 权重[0, 100], 0为禁用
	Weight *uint64 `json:"Weight,omitnil,omitempty" name:"Weight"`

	// CVM实例ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	VmInstanceId *string `json:"VmInstanceId,omitnil,omitempty" name:"VmInstanceId"`

	// 染色标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*string `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 节点健康状态,创建、编辑时不需要传该参数。OFF:关闭,HEALTHY:健康,UNHEALTHY:异常,NO_DATA:数据未上报。目前只支持VPC通道。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Healthy *string `json:"Healthy,omitnil,omitempty" name:"Healthy"`

	// K8S容器服务名字
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`

	// K8S命名空间
	// 注意:此字段可能返回 null,表示取不到有效值。
	NameSpace *string `json:"NameSpace,omitnil,omitempty" name:"NameSpace"`

	// TKE集群的ID
	// 注意:此字段可能返回 null,表示取不到有效值。
	ClusterId *string `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Node的来源,取值范围:K8S
	// 注意:此字段可能返回 null,表示取不到有效值。
	Source *string `json:"Source,omitnil,omitempty" name:"Source"`

	// API网关内部记录唯一的服务名字
	// 注意:此字段可能返回 null,表示取不到有效值。
	UniqueServiceName *string `json:"UniqueServiceName,omitnil,omitempty" name:"UniqueServiceName"`
}

type UsagePlan

type UsagePlan struct {
	// 环境名称。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 使用计划唯一ID。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 使用计划名称。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 使用计划描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 使用计划qps,-1表示没有限制。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 使用计划时间。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 使用计划修改时间。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`
}

type UsagePlanBindEnvironment

type UsagePlanBindEnvironment struct {
	// 环境名。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnvironmentName *string `json:"EnvironmentName,omitnil,omitempty" name:"EnvironmentName"`

	// 服务唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`
}

type UsagePlanBindSecret

type UsagePlanBindSecret struct {
	// 密钥ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AccessKeyId *string `json:"AccessKeyId,omitnil,omitempty" name:"AccessKeyId"`

	// 密钥名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥状态,0表示已禁用,1表示启用中。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type UsagePlanBindSecretStatus

type UsagePlanBindSecretStatus struct {
	// 使用计划绑定密钥的数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 密钥详情列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AccessKeyList []*UsagePlanBindSecret `json:"AccessKeyList,omitnil,omitempty" name:"AccessKeyList"`
}

type UsagePlanEnvironment

type UsagePlanEnvironment struct {
	// 绑定的服务唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceId *string `json:"ServiceId,omitnil,omitempty" name:"ServiceId"`

	// API 的唯一ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiId *string `json:"ApiId,omitnil,omitempty" name:"ApiId"`

	// API 的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ApiName *string `json:"ApiName,omitnil,omitempty" name:"ApiName"`

	// API 的路径。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Path *string `json:"Path,omitnil,omitempty" name:"Path"`

	// API 的方法。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Method *string `json:"Method,omitnil,omitempty" name:"Method"`

	// 已经绑定的环境名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Environment *string `json:"Environment,omitnil,omitempty" name:"Environment"`

	// 已经使用的配额。
	// 注意:此字段可能返回 null,表示取不到有效值。
	InUseRequestNum *int64 `json:"InUseRequestNum,omitnil,omitempty" name:"InUseRequestNum"`

	// 最大请求量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 每秒最大请求次数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 服务名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ServiceName *string `json:"ServiceName,omitnil,omitempty" name:"ServiceName"`
}

type UsagePlanEnvironmentStatus

type UsagePlanEnvironmentStatus struct {
	// 使用计划绑定的服务的环境数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 使用计划已经绑定的各个服务的环境状态。
	// 注意:此字段可能返回 null,表示取不到有效值。
	EnvironmentList []*UsagePlanEnvironment `json:"EnvironmentList,omitnil,omitempty" name:"EnvironmentList"`
}

type UsagePlanInfo

type UsagePlanInfo struct {
	// 使用计划唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 使用计划名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 使用计划描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 每秒请求限制数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 最大调用次数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 绑定密钥的数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindSecretIdTotalCount *int64 `json:"BindSecretIdTotalCount,omitnil,omitempty" name:"BindSecretIdTotalCount"`

	// 绑定密钥的详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindSecretIds []*string `json:"BindSecretIds,omitnil,omitempty" name:"BindSecretIds"`

	// 绑定环境数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindEnvironmentTotalCount *int64 `json:"BindEnvironmentTotalCount,omitnil,omitempty" name:"BindEnvironmentTotalCount"`

	// 绑定环境详情。
	// 注意:此字段可能返回 null,表示取不到有效值。
	BindEnvironments []*UsagePlanBindEnvironment `json:"BindEnvironments,omitnil,omitempty" name:"BindEnvironments"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type UsagePlanStatusInfo

type UsagePlanStatusInfo struct {
	// 使用计划唯一 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanId *string `json:"UsagePlanId,omitnil,omitempty" name:"UsagePlanId"`

	// 用户自定义的使用计划名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanName *string `json:"UsagePlanName,omitnil,omitempty" name:"UsagePlanName"`

	// 用户自定义的使用计划描述。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanDesc *string `json:"UsagePlanDesc,omitnil,omitempty" name:"UsagePlanDesc"`

	// 每秒最大请求次数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitnil,omitempty" name:"MaxRequestNumPreSec"`

	// 请求配额总量,-1表示没有限制。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxRequestNum *int64 `json:"MaxRequestNum,omitnil,omitempty" name:"MaxRequestNum"`

	// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CreatedTime *string `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`

	// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ModifiedTime *string `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`

	// 标签
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type UsagePlansStatus

type UsagePlansStatus struct {
	// 符合条件的使用计划数量。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 使用计划列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UsagePlanStatusSet []*UsagePlanStatusInfo `json:"UsagePlanStatusSet,omitnil,omitempty" name:"UsagePlanStatusSet"`
}

type VpcConfig added in v1.0.288

type VpcConfig struct {
	// vpcid
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// subnetid
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL