Documentation
¶
Index ¶
- Constants
- type APIDoc
- type APIDocInfo
- type APIDocs
- type ApiEnvironmentStrategy
- type ApiEnvironmentStrategyStataus
- type ApiIdStatus
- type ApiInfo
- type ApiKey
- type ApiKeysStatus
- type ApiRequestConfig
- type ApiUsagePlan
- type ApiUsagePlanSet
- type ApisStatus
- type AttachedApiInfo
- type Base64EncodedTriggerRule
- type BindEnvironmentRequest
- type BindEnvironmentResponse
- type BindIPStrategyRequest
- type BindIPStrategyResponse
- type BindSecretIdsRequest
- type BindSecretIdsResponse
- type BindSubDomainRequest
- type BindSubDomainResponse
- type BuildAPIDocRequest
- type BuildAPIDocResponse
- type Client
- func (c *Client) BindEnvironment(request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
- func (c *Client) BindIPStrategy(request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
- func (c *Client) BindSecretIds(request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
- func (c *Client) BindSubDomain(request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
- func (c *Client) BuildAPIDoc(request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
- func (c *Client) CreateAPIDoc(request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
- func (c *Client) CreateApi(request *CreateApiRequest) (response *CreateApiResponse, err error)
- func (c *Client) CreateApiKey(request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
- func (c *Client) CreateIPStrategy(request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
- func (c *Client) CreateService(request *CreateServiceRequest) (response *CreateServiceResponse, err error)
- func (c *Client) CreateUsagePlan(request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
- func (c *Client) DeleteAPIDoc(request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
- func (c *Client) DeleteApi(request *DeleteApiRequest) (response *DeleteApiResponse, err error)
- func (c *Client) DeleteApiKey(request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
- func (c *Client) DeleteIPStrategy(request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
- func (c *Client) DeleteService(request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)
- func (c *Client) DeleteServiceSubDomainMapping(request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)
- func (c *Client) DeleteUsagePlan(request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
- func (c *Client) DemoteServiceUsagePlan(request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
- func (c *Client) DescribeAPIDocDetail(request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
- func (c *Client) DescribeAPIDocs(request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
- func (c *Client) DescribeApi(request *DescribeApiRequest) (response *DescribeApiResponse, err error)
- func (c *Client) DescribeApiEnvironmentStrategy(request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeApiKey(request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
- func (c *Client) DescribeApiKeysStatus(request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
- func (c *Client) DescribeApiUsagePlan(request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
- func (c *Client) DescribeApisStatus(request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)
- func (c *Client) DescribeIPStrategy(request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)
- func (c *Client) DescribeIPStrategyApisStatus(request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)
- func (c *Client) DescribeIPStrategysStatus(request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
- func (c *Client) DescribeLogSearch(request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
- func (c *Client) DescribePlugins(request *DescribePluginsRequest) (response *DescribePluginsResponse, err error)
- func (c *Client) DescribeService(request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)
- func (c *Client) DescribeServiceEnvironmentList(request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)
- func (c *Client) DescribeServiceEnvironmentReleaseHistory(request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
- func (c *Client) DescribeServiceEnvironmentStrategy(request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeServiceReleaseVersion(request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
- func (c *Client) DescribeServiceSubDomainMappings(request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
- func (c *Client) DescribeServiceSubDomains(request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
- func (c *Client) DescribeServiceUsagePlan(request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
- func (c *Client) DescribeServicesStatus(request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)
- func (c *Client) DescribeUsagePlan(request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)
- func (c *Client) DescribeUsagePlanEnvironments(request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)
- func (c *Client) DescribeUsagePlanSecretIds(request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
- func (c *Client) DescribeUsagePlansStatus(request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
- func (c *Client) DisableApiKey(request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
- func (c *Client) EnableApiKey(request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
- func (c *Client) GenerateApiDocument(request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
- func (c *Client) ModifyAPIDoc(request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
- func (c *Client) ModifyApi(request *ModifyApiRequest) (response *ModifyApiResponse, err error)
- func (c *Client) ModifyApiEnvironmentStrategy(request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
- func (c *Client) ModifyApiIncrement(request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
- func (c *Client) ModifyIPStrategy(request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
- func (c *Client) ModifyService(request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)
- func (c *Client) ModifyServiceEnvironmentStrategy(request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)
- func (c *Client) ModifySubDomain(request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
- func (c *Client) ModifyUsagePlan(request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
- func (c *Client) ReleaseService(request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
- func (c *Client) ResetAPIDocPassword(request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
- func (c *Client) UnBindEnvironment(request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
- func (c *Client) UnBindIPStrategy(request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
- func (c *Client) UnBindSecretIds(request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
- func (c *Client) UnBindSubDomain(request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
- func (c *Client) UnReleaseService(request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
- func (c *Client) UpdateApiKey(request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
- func (c *Client) UpdateService(request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
- type ConstantParameter
- type CreateAPIDocRequest
- type CreateAPIDocResponse
- type CreateApiKeyRequest
- type CreateApiKeyResponse
- type CreateApiRequest
- type CreateApiResponse
- type CreateApiRsp
- type CreateIPStrategyRequest
- type CreateIPStrategyResponse
- type CreateServiceRequest
- type CreateServiceResponse
- type CreateUsagePlanRequest
- type CreateUsagePlanResponse
- type DeleteAPIDocRequest
- type DeleteAPIDocResponse
- type DeleteApiKeyRequest
- type DeleteApiKeyResponse
- type DeleteApiRequest
- type DeleteApiResponse
- type DeleteIPStrategyRequest
- type DeleteIPStrategyResponse
- type DeleteServiceRequest
- type DeleteServiceResponse
- type DeleteServiceSubDomainMappingRequest
- type DeleteServiceSubDomainMappingResponse
- type DeleteUsagePlanRequest
- type DeleteUsagePlanResponse
- type DemoteServiceUsagePlanRequest
- type DemoteServiceUsagePlanResponse
- type DesApisStatus
- type DescribeAPIDocDetailRequest
- type DescribeAPIDocDetailResponse
- type DescribeAPIDocsRequest
- type DescribeAPIDocsResponse
- type DescribeApiEnvironmentStrategyRequest
- type DescribeApiEnvironmentStrategyResponse
- type DescribeApiKeyRequest
- type DescribeApiKeyResponse
- type DescribeApiKeysStatusRequest
- type DescribeApiKeysStatusResponse
- type DescribeApiRequest
- type DescribeApiResponse
- type DescribeApiUsagePlanRequest
- type DescribeApiUsagePlanResponse
- type DescribeApisStatusRequest
- type DescribeApisStatusResponse
- type DescribeIPStrategyApisStatusRequest
- type DescribeIPStrategyApisStatusResponse
- type DescribeIPStrategyRequest
- type DescribeIPStrategyResponse
- type DescribeIPStrategysStatusRequest
- type DescribeIPStrategysStatusResponse
- type DescribeLogSearchRequest
- type DescribeLogSearchResponse
- type DescribePluginsRequest
- type DescribePluginsResponse
- type DescribeServiceEnvironmentListRequest
- type DescribeServiceEnvironmentListResponse
- type DescribeServiceEnvironmentReleaseHistoryRequest
- type DescribeServiceEnvironmentReleaseHistoryResponse
- type DescribeServiceEnvironmentStrategyRequest
- type DescribeServiceEnvironmentStrategyResponse
- type DescribeServiceReleaseVersionRequest
- type DescribeServiceReleaseVersionResponse
- type DescribeServiceRequest
- type DescribeServiceResponse
- type DescribeServiceSubDomainMappingsRequest
- type DescribeServiceSubDomainMappingsResponse
- type DescribeServiceSubDomainsRequest
- type DescribeServiceSubDomainsResponse
- type DescribeServiceUsagePlanRequest
- type DescribeServiceUsagePlanResponse
- type DescribeServicesStatusRequest
- type DescribeServicesStatusResponse
- type DescribeUsagePlanEnvironmentsRequest
- type DescribeUsagePlanEnvironmentsResponse
- type DescribeUsagePlanRequest
- type DescribeUsagePlanResponse
- type DescribeUsagePlanSecretIdsRequest
- type DescribeUsagePlanSecretIdsResponse
- type DescribeUsagePlansStatusRequest
- type DescribeUsagePlansStatusResponse
- type DisableApiKeyRequest
- type DisableApiKeyResponse
- type DocumentSDK
- type DomainSetList
- type DomainSets
- type EnableApiKeyRequest
- type EnableApiKeyResponse
- type Environment
- type EnvironmentStrategy
- type ErrorCodes
- type Filter
- type GenerateApiDocumentRequest
- type GenerateApiDocumentResponse
- type HealthCheckConf
- type IPStrategy
- type IPStrategyApi
- type IPStrategyApiStatus
- type IPStrategysStatus
- type LogQuery
- type MicroService
- type MicroServiceReq
- type ModifyAPIDocRequest
- type ModifyAPIDocResponse
- type ModifyApiEnvironmentStrategyRequest
- type ModifyApiEnvironmentStrategyResponse
- type ModifyApiIncrementRequest
- type ModifyApiIncrementResponse
- type ModifyApiRequest
- type ModifyApiResponse
- type ModifyIPStrategyRequest
- type ModifyIPStrategyResponse
- type ModifyServiceEnvironmentStrategyRequest
- type ModifyServiceEnvironmentStrategyResponse
- type ModifyServiceRequest
- type ModifyServiceResponse
- type ModifySubDomainRequest
- type ModifySubDomainResponse
- type ModifyUsagePlanRequest
- type ModifyUsagePlanResponse
- type OauthConfig
- type PathMapping
- type Plugin
- type PluginSummary
- type ReleaseService
- type ReleaseServiceRequest
- type ReleaseServiceResponse
- type ReqParameter
- type RequestConfig
- type RequestParameter
- type ResetAPIDocPasswordRequest
- type ResetAPIDocPasswordResponse
- type ResponseErrorCodeReq
- type Service
- type ServiceConfig
- type ServiceEnvironmentSet
- type ServiceEnvironmentStrategy
- type ServiceEnvironmentStrategyStatus
- type ServiceParameter
- type ServiceReleaseHistory
- type ServiceReleaseHistoryInfo
- type ServiceReleaseVersion
- type ServiceSubDomainMappings
- type ServiceUsagePlanSet
- type ServicesStatus
- type Tag
- type TargetServicesReq
- type TsfLoadBalanceConfResp
- type UnBindEnvironmentRequest
- type UnBindEnvironmentResponse
- type UnBindIPStrategyRequest
- type UnBindIPStrategyResponse
- type UnBindSecretIdsRequest
- type UnBindSecretIdsResponse
- type UnBindSubDomainRequest
- type UnBindSubDomainResponse
- type UnReleaseServiceRequest
- type UnReleaseServiceResponse
- type UpdateApiKeyRequest
- type UpdateApiKeyResponse
- type UpdateServiceRequest
- type UpdateServiceResponse
- type UsagePlan
- type UsagePlanBindEnvironment
- type UsagePlanBindSecret
- type UsagePlanBindSecretStatus
- type UsagePlanEnvironment
- type UsagePlanEnvironmentStatus
- type UsagePlanInfo
- type UsagePlanStatusInfo
- type UsagePlansStatus
Constants ¶
const APIVersion = "2018-08-08"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIDocInfo ¶
type APIDocInfo struct {
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
// API文档名称
ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"`
// API文档构建状态
ApiDocStatus *string `json:"ApiDocStatus,omitempty" name:"ApiDocStatus"`
// API文档API数量
ApiCount *int64 `json:"ApiCount,omitempty" name:"ApiCount"`
// API文档查看次数
ViewCount *int64 `json:"ViewCount,omitempty" name:"ViewCount"`
// API文档发布次数
ReleaseCount *int64 `json:"ReleaseCount,omitempty" name:"ReleaseCount"`
// API文档访问URI
ApiDocUri *string `json:"ApiDocUri,omitempty" name:"ApiDocUri"`
SharePassword *string `json:"SharePassword,omitempty" name:"SharePassword"`
// API文档更新时间
UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"`
// 服务ID
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境信息
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 生成API文档的API ID
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
// 服务名称
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 生成API文档的API名称
ApiNames []*string `json:"ApiNames,omitempty" name:"ApiNames" list`
}
type ApiEnvironmentStrategy ¶
type ApiEnvironmentStrategy struct {
// API唯一ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 用户自定义API名称。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API的路径。如/path。
Path *string `json:"Path,omitempty" name:"Path"`
// API的方法。如GET。
Method *string `json:"Method,omitempty" name:"Method"`
// 环境的限流信息。
EnvironmentStrategySet []*EnvironmentStrategy `json:"EnvironmentStrategySet,omitempty" name:"EnvironmentStrategySet" list`
}
type ApiEnvironmentStrategyStataus ¶
type ApiEnvironmentStrategyStataus struct {
// API绑定的限流策略数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// API绑定的限流策略列表。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiEnvironmentStrategySet []*ApiEnvironmentStrategy `json:"ApiEnvironmentStrategySet,omitempty" name:"ApiEnvironmentStrategySet" list`
}
type ApiIdStatus ¶
type ApiIdStatus struct {
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API唯一ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// API描述
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// API PATH。
Path *string `json:"Path,omitempty" name:"Path"`
// API METHOD。
Method *string `json:"Method,omitempty" name:"Method"`
// 服务创建时间。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 服务修改时间。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// API名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// VPC唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"`
// API类型。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API协议。
// 注意:此字段可能返回 null,表示取不到有效值。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 是否买后调试。
// 注意:此字段可能返回 null,表示取不到有效值。
IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"`
// 授权类型。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthType *string `json:"AuthType,omitempty" name:"AuthType"`
// API业务类型。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"`
// 关联授权API唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"`
// 授权API关联的业务API列表。
// 注意:此字段可能返回 null,表示取不到有效值。
RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitempty" name:"RelationBuniessApiIds" list`
// oauth配置信息。
// 注意:此字段可能返回 null,表示取不到有效值。
OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"`
// oauth2.0API请求,token存放位置。
// 注意:此字段可能返回 null,表示取不到有效值。
TokenLocation *string `json:"TokenLocation,omitempty" name:"TokenLocation"`
}
type ApiInfo ¶
type ApiInfo struct {
// API 所在的服务唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 所在的服务的名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// API 所在的服务的描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// API 接口唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// API 接口的描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// 创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 最后修改时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// API 接口的名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API 类型。可取值为NORMAL(普通API)、TSF(微服务API)。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
// 注意:此字段可能返回 null,表示取不到有效值。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// API 鉴权类型。可取值为 SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthType *string `json:"AuthType,omitempty" name:"AuthType"`
// OAUTH API的类型。可取值为NORMAL(业务API)、�OAUTH(授权API)。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"`
// OAUTH 业务API 关联的授权API 唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"`
// OAUTH配置。
// 注意:此字段可能返回 null,表示取不到有效值。
OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"`
// 是否购买后调试(云市场预留参数)。
// 注意:此字段可能返回 null,表示取不到有效值。
IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"`
// 请求的前端配置。
// 注意:此字段可能返回 null,表示取不到有效值。
RequestConfig *RequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"`
// 返回类型。
// 注意:此字段可能返回 null,表示取不到有效值。
ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"`
// 自定义响应配置成功响应示例。
// 注意:此字段可能返回 null,表示取不到有效值。
ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"`
// 自定义响应配置失败响应示例。
// 注意:此字段可能返回 null,表示取不到有效值。
ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"`
// 用户自定义错误码配置。
// 注意:此字段可能返回 null,表示取不到有效值。
ResponseErrorCodes []*ErrorCodes `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes" list`
// 前端请求参数。
// 注意:此字段可能返回 null,表示取不到有效值。
RequestParameters []*ReqParameter `json:"RequestParameters,omitempty" name:"RequestParameters" list`
// API 的后端服务超时时间,单位是秒。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"`
// API 的后端服务类型。可取值为 HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"`
// API 的后端服务配置。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"`
// API的后端服务参数。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters" list`
// 常量参数。
// 注意:此字段可能返回 null,表示取不到有效值。
ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters" list`
// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"`
// scf 函数名称。当后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"`
// scf 函数命名空间。当后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"`
// scf函数版本。当后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"`
// 是否开启集成响应。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"`
// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"`
// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`
// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"`
// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`
// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`
// WEBSOCKET 回推地址。
// 注意:此字段可能返回 null,表示取不到有效值。
InternalDomain *string `json:"InternalDomain,omitempty" name:"InternalDomain"`
// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"`
// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`
// API绑定微服务服务列表。
// 注意:此字段可能返回 null,表示取不到有效值。
MicroServices []*MicroService `json:"MicroServices,omitempty" name:"MicroServices" list`
// 微服务信息详情。
// 注意:此字段可能返回 null,表示取不到有效值。
MicroServicesInfo []*int64 `json:"MicroServicesInfo,omitempty" name:"MicroServicesInfo" list`
// 微服务的负载均衡配置。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"`
// 微服务的健康检查配置。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"`
// 是否开启跨域。
// 注意:此字段可能返回 null,表示取不到有效值。
EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"`
// API绑定的tag信息。
// 注意:此字段可能返回 null,表示取不到有效值。
Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`
// API已发布的环境信息。
// 注意:此字段可能返回 null,表示取不到有效值。
Environments []*string `json:"Environments,omitempty" name:"Environments" list`
// 是否开启Base64编码,只有后端为scf时才会生效。
// 注意:此字段可能返回 null,表示取不到有效值。
IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"`
// 是否开启Base64编码的header触发,只有后端为scf时才会生效。
// 注意:此字段可能返回 null,表示取不到有效值。
IsBase64Trigger *bool `json:"IsBase64Trigger,omitempty" name:"IsBase64Trigger"`
// Header触发规则,总规则数量不超过10。
// 注意:此字段可能返回 null,表示取不到有效值。
Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitempty" name:"Base64EncodedTriggerRules" list`
}
type ApiKey ¶
type ApiKey struct {
// 创建的 API 密钥 ID 。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
// 创建的 API 密钥 Key。
AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"`
// 密钥类型,auto 或者 manual。
AccessKeyType *string `json:"AccessKeyType,omitempty" name:"AccessKeyType"`
// 用户自定义密钥名称。
SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
// 最后一次修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 密钥状态。0表示禁用,1表示启用。
Status *int64 `json:"Status,omitempty" name:"Status"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
}
type ApiKeysStatus ¶
type ApiRequestConfig ¶
type ApiUsagePlan ¶
type ApiUsagePlan struct {
// 服务唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// API 名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API 路径。
// 注意:此字段可能返回 null,表示取不到有效值。
Path *string `json:"Path,omitempty" name:"Path"`
// API 方法。
// 注意:此字段可能返回 null,表示取不到有效值。
Method *string `json:"Method,omitempty" name:"Method"`
// 使用计划的唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 使用计划的名称。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 使用计划的描述。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 使用计划绑定的服务环境。
// 注意:此字段可能返回 null,表示取不到有效值。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 已经使用的配额。
// 注意:此字段可能返回 null,表示取不到有效值。
InUseRequestNum *int64 `json:"InUseRequestNum,omitempty" name:"InUseRequestNum"`
// 请求配额总量,-1表示没有限制。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 请求 QPS 上限,-1 表示没有限制。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
// 使用计划创建时间。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 使用计划最后修改时间。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 服务名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
}
type ApiUsagePlanSet ¶
type ApiUsagePlanSet struct {
// API 绑定的使用计划总数。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// API 绑定使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiUsagePlanList []*ApiUsagePlan `json:"ApiUsagePlanList,omitempty" name:"ApiUsagePlanList" list`
}
type ApisStatus ¶
type ApisStatus struct {
// 符合条件的 API 接口数量。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// API 接口列表。
ApiIdStatusSet []*DesApisStatus `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet" list`
}
type AttachedApiInfo ¶
type AttachedApiInfo struct {
// API所在服务ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API所在服务名称。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// API所在服务描述信息。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// API ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// API名称。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// 插件绑定API的环境。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 插件和API绑定时间。
AttachedTime *string `json:"AttachedTime,omitempty" name:"AttachedTime"`
}
type Base64EncodedTriggerRule ¶
type Base64EncodedTriggerRule struct {
// 进行编码触发的header,可选值 "Accept"和"Content_Type" 对应实际数据流请求header中的Accept和 Content-Type。
Name *string `json:"Name,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,omitempty" name:"Value" list`
}
type BindEnvironmentRequest ¶
type BindEnvironmentRequest struct {
*tchttp.BaseRequest
// 待绑定的使用计划唯一 ID 列表。
UsagePlanIds []*string `json:"UsagePlanIds,omitempty" name:"UsagePlanIds" list`
// 绑定类型,取值为API、SERVICE,默认值为SERVICE。
BindType *string `json:"BindType,omitempty" name:"BindType"`
// 待绑定的环境。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 待绑定的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API唯一ID数组,当bindType=API时,需要传入此参数。
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewBindEnvironmentRequest ¶
func NewBindEnvironmentRequest() (request *BindEnvironmentRequest)
func (*BindEnvironmentRequest) FromJsonString ¶
func (r *BindEnvironmentRequest) FromJsonString(s string) error
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 BindEnvironmentResponse ¶
type BindEnvironmentResponse struct {
*tchttp.BaseResponse
Response *struct {
// 绑定操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewBindEnvironmentResponse ¶
func NewBindEnvironmentResponse() (response *BindEnvironmentResponse)
func (*BindEnvironmentResponse) FromJsonString ¶
func (r *BindEnvironmentResponse) FromJsonString(s string) error
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 BindIPStrategyRequest ¶
type BindIPStrategyRequest struct {
*tchttp.BaseRequest
// 待绑定的IP策略所属的服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待绑定的IP策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// IP策略待绑定的环境。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// IP策略待绑定的API列表。
BindApiIds []*string `json:"BindApiIds,omitempty" name:"BindApiIds" list`
}
func NewBindIPStrategyRequest ¶
func NewBindIPStrategyRequest() (request *BindIPStrategyRequest)
func (*BindIPStrategyRequest) FromJsonString ¶
func (r *BindIPStrategyRequest) FromJsonString(s string) error
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 BindIPStrategyResponse ¶
type BindIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 绑定操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewBindIPStrategyResponse ¶
func NewBindIPStrategyResponse() (response *BindIPStrategyResponse)
func (*BindIPStrategyResponse) FromJsonString ¶
func (r *BindIPStrategyResponse) FromJsonString(s string) error
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 BindSecretIdsRequest ¶
type BindSecretIdsRequest struct {
*tchttp.BaseRequest
// 待绑定的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 待绑定的密钥 ID 数组。
AccessKeyIds []*string `json:"AccessKeyIds,omitempty" name:"AccessKeyIds" list`
}
func NewBindSecretIdsRequest ¶
func NewBindSecretIdsRequest() (request *BindSecretIdsRequest)
func (*BindSecretIdsRequest) FromJsonString ¶
func (r *BindSecretIdsRequest) FromJsonString(s string) error
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 BindSecretIdsResponse ¶
type BindSecretIdsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 绑定操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewBindSecretIdsResponse ¶
func NewBindSecretIdsResponse() (response *BindSecretIdsResponse)
func (*BindSecretIdsResponse) FromJsonString ¶
func (r *BindSecretIdsResponse) FromJsonString(s string) error
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 BindSubDomainRequest ¶
type BindSubDomainRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待绑定的自定义的域名。
SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"`
// 服务支持协议,可选值为http、https、http&https。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 网络类型,可选值为OUTER、INNER。
NetType *string `json:"NetType,omitempty" name:"NetType"`
// 是否使用默认路径映射,默认为 true。为 false 时,表示自定义路径映射,此时 PathMappingSet 必填。
IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"`
// 默认域名。
NetSubDomain *string `json:"NetSubDomain,omitempty" name:"NetSubDomain"`
// 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。
CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"`
// 自定义域名路径映射,最多输入三个Environment,并且只能分别取值“test”、 ”prepub“、”release“。
PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet" list`
// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
IsForcedHttps *bool `json:"IsForcedHttps,omitempty" name:"IsForcedHttps"`
}
func NewBindSubDomainRequest ¶
func NewBindSubDomainRequest() (request *BindSubDomainRequest)
func (*BindSubDomainRequest) FromJsonString ¶
func (r *BindSubDomainRequest) FromJsonString(s string) error
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 BindSubDomainResponse ¶
type BindSubDomainResponse struct {
*tchttp.BaseResponse
Response *struct {
// 绑定操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewBindSubDomainResponse ¶
func NewBindSubDomainResponse() (response *BindSubDomainResponse)
func (*BindSubDomainResponse) FromJsonString ¶
func (r *BindSubDomainResponse) FromJsonString(s string) error
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 BuildAPIDocRequest ¶
type BuildAPIDocRequest struct {
*tchttp.BaseRequest
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
}
func NewBuildAPIDocRequest ¶
func NewBuildAPIDocRequest() (request *BuildAPIDocRequest)
func (*BuildAPIDocRequest) FromJsonString ¶
func (r *BuildAPIDocRequest) FromJsonString(s string) error
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 BuildAPIDocResponse ¶
type BuildAPIDocResponse struct {
*tchttp.BaseResponse
Response *struct {
// 操作是否成功
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewBuildAPIDocResponse ¶
func NewBuildAPIDocResponse() (response *BuildAPIDocResponse)
func (*BuildAPIDocResponse) FromJsonString ¶
func (r *BuildAPIDocResponse) FromJsonString(s string) error
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 Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) BindEnvironment ¶
func (c *Client) BindEnvironment(request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
本接口(BindEnvironment)用于绑定使用计划到服务或API。 用户在发布服务到某个环境中后,如果 API 需要鉴权,还需要绑定使用计划才能进行调用,此接口用户将使用计划绑定到特定环境。 目前支持绑定使用计划到API,但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划,所以对已经绑定过服务级别使用计划的环境,请先使用 服务级别使用计划降级 接口进行降级操作。
func (*Client) BindIPStrategy ¶
func (c *Client) BindIPStrategy(request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
本接口(BindIPStrategy)用于API绑定IP策略。
func (*Client) BindSecretIds ¶
func (c *Client) BindSecretIds(request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
本接口(BindSecretIds)用于为使用计划绑定密钥。 将密钥绑定到某个使用计划,并将此使用计划绑定到某个服务发布的环境上,调用者方可使用此密钥调用这个服务中的 API,可使用本接口为使用计划绑定密钥。
func (*Client) BindSubDomain ¶
func (c *Client) BindSubDomain(request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
本接口(BindSubDomain)用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用,但当用户想使用自己的已有域名时,也可以将自定义域名绑定到此服务,在做好备案、与默认域名的 CNAME 后,可直接调用自定义域名。
func (*Client) BuildAPIDoc ¶
func (c *Client) BuildAPIDoc(request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
构建 API 文档
func (*Client) CreateAPIDoc ¶
func (c *Client) CreateAPIDoc(request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
创建 API 文档
func (*Client) CreateApi ¶
func (c *Client) CreateApi(request *CreateApiRequest) (response *CreateApiResponse, err error)
本接口(CreateApi)用于创建 API 接口,创建 API 前,用户需要先创建服务,每个 API 都有自己归属的服务。
func (*Client) CreateApiKey ¶
func (c *Client) CreateApiKey(request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
本接口(CreateApiKey)用于创建一对新的 API 密钥。
func (*Client) CreateIPStrategy ¶
func (c *Client) CreateIPStrategy(request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
本接口(CreateIPStrategy)用于创建服务IP策略。
func (*Client) CreateService ¶
func (c *Client) CreateService(request *CreateServiceRequest) (response *CreateServiceResponse, err error)
本接口(CreateService)用于创建服务。 API 网关使用的最大单元为服务,每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用,用户也可绑定自定义域名到此服务中。
func (*Client) CreateUsagePlan ¶
func (c *Client) CreateUsagePlan(request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
本接口(CreateUsagePlan)用于创建使用计划。 用户在使用 API 网关时,需要创建使用计划并将其绑定到服务的环境中使用。
func (*Client) DeleteAPIDoc ¶
func (c *Client) DeleteAPIDoc(request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
删除 API 文档
func (*Client) DeleteApi ¶
func (c *Client) DeleteApi(request *DeleteApiRequest) (response *DeleteApiResponse, err error)
本接口(DeleteApi)用于删除已经创建的API。
func (*Client) DeleteApiKey ¶
func (c *Client) DeleteApiKey(request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
本接口(DeleteApiKey)用于删除一对 API 密钥。
func (*Client) DeleteIPStrategy ¶
func (c *Client) DeleteIPStrategy(request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
本接口(DeleteIPStrategy)用于删除服务IP策略。
func (*Client) DeleteService ¶
func (c *Client) DeleteService(request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)
本接口(DeleteService)用于删除 API 网关中某个服务。
func (*Client) DeleteServiceSubDomainMapping ¶
func (c *Client) DeleteServiceSubDomainMapping(request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)
本接口(DeleteServiceSubDomainMapping)用于删除服务中某个环境的自定义域名映射。 当用户使用自定义域名,并使用了自定义映射时,可使用此接口。但需注意,若删除了所有环境的映射时,调用此 API 均会返回失败。
func (*Client) DeleteUsagePlan ¶
func (c *Client) DeleteUsagePlan(request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
本接口(DeleteUsagePlan)用于删除使用计划。
func (*Client) DemoteServiceUsagePlan ¶
func (c *Client) DemoteServiceUsagePlan(request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
本接口(DemoteServiceUsagePlan)用于将某个服务在某个环境的使用计划,降级到API上。 如果服务内没有API不允许进行此操作。 如果当前环境没有发布,不允许进行此操作。
func (*Client) DescribeAPIDocDetail ¶
func (c *Client) DescribeAPIDocDetail(request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
查询 API 文档详情
func (*Client) DescribeAPIDocs ¶
func (c *Client) DescribeAPIDocs(request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
查询 API 文档列表
func (*Client) DescribeApi ¶
func (c *Client) DescribeApi(request *DescribeApiRequest) (response *DescribeApiResponse, err error)
本接口(DescribeApi)用于查询用户 API 网关的 API 接口的详细信息。
func (*Client) DescribeApiEnvironmentStrategy ¶
func (c *Client) DescribeApiEnvironmentStrategy(request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
本接口(DescribeApiEnvironmentStrategy)用于展示API绑定的限流策略。
func (*Client) DescribeApiKey ¶
func (c *Client) DescribeApiKey(request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
本接口(DescribeApiKey)用于查询密钥详情。 用户在创建密钥后,可用此接口查询一个 API 密钥的详情,该接口会显示密钥 Key。
func (*Client) DescribeApiKeysStatus ¶
func (c *Client) DescribeApiKeysStatus(request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
本接口(DescribeApiKeysStatus)用于查询密钥列表。 当用户创建了多个密钥对时,可使用本接口查询一个或多个 API 密钥信息,本接口不会显示密钥 Key。
func (*Client) DescribeApiUsagePlan ¶
func (c *Client) DescribeApiUsagePlan(request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
本接口(DescribeApiUsagePlan)用于查询服务中 API 使用计划详情。 服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务及其中 API 的所有使用计划。
func (*Client) DescribeApisStatus ¶
func (c *Client) DescribeApisStatus(request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)
本接口(DescribeApisStatus)用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。
func (*Client) DescribeIPStrategy ¶
func (c *Client) DescribeIPStrategy(request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)
本接口(DescribeIPStrategy)用于查询IP策略详情。
func (*Client) DescribeIPStrategyApisStatus ¶
func (c *Client) DescribeIPStrategyApisStatus(request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)
本接口(DescribeIPStrategyApisStatus)用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。
func (*Client) DescribeIPStrategysStatus ¶
func (c *Client) DescribeIPStrategysStatus(request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
本接口(DescribeIPStrategysStatus)用于查询服务IP策略列表。
func (*Client) DescribeLogSearch ¶
func (c *Client) DescribeLogSearch(request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
本接口DescribeLogSearch用于搜索日志
func (*Client) DescribePlugins ¶
func (c *Client) DescribePlugins(request *DescribePluginsRequest) (response *DescribePluginsResponse, err error)
展示插件列表和详情,支持分页,支持按照插件类型查询,支持按照插件ID批量查询,支持按照插件名称查询。
func (*Client) DescribeService ¶
func (c *Client) DescribeService(request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)
本接口(DescribeService)用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。
func (*Client) DescribeServiceEnvironmentList ¶
func (c *Client) DescribeServiceEnvironmentList(request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)
本接口(DescribeServiceEnvironmentList)用于查询一个服务的环境列表,可查询到此服务下所有环境及其状态。
func (*Client) DescribeServiceEnvironmentReleaseHistory ¶
func (c *Client) DescribeServiceEnvironmentReleaseHistory(request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
本接口(DescribeServiceEnvironmentReleaseHistory)用于查询服务环境的发布历史。 用户在创建好服务后需要发布到某个环境中才能进行使用,本接口用于查询一个服务某个环境的发布记录。
func (*Client) DescribeServiceEnvironmentStrategy ¶
func (c *Client) DescribeServiceEnvironmentStrategy(request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
本接口(DescribeServiceEnvironmentStrategy)用于展示服务限流策略。
func (*Client) DescribeServiceReleaseVersion ¶
func (c *Client) DescribeServiceReleaseVersion(request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
本接口(DescribeServiceReleaseVersion)查询一个服务下面所有已经发布的版本列表。 用户在发布服务时,常有多个版本发布,可使用本接口查询已发布的版本。
func (*Client) DescribeServiceSubDomainMappings ¶
func (c *Client) DescribeServiceSubDomainMappings(request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
本接口(DescribeServiceSubDomainMappings)用于查询自定义域名的路径映射。 API 网关可绑定自定义域名到服务,并且可以对自定义域名的路径进行映射,可自定义不同的路径映射到服务中的三个环境,本接口用于查询绑定服务的自定义域名的路径映射列表。
func (*Client) DescribeServiceSubDomains ¶
func (c *Client) DescribeServiceSubDomains(request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
本接口(DescribeServiceSubDomains)用于查询自定义域名列表。 API 网关可绑定自定义域名到服务,用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。
func (*Client) DescribeServiceUsagePlan ¶
func (c *Client) DescribeServiceUsagePlan(request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
本接口(DescribeServiceUsagePlan)用于查询服务使用计划详情。 服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务的所有使用计划。
func (*Client) DescribeServicesStatus ¶
func (c *Client) DescribeServicesStatus(request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)
本接口(DescribeServicesStatus)用于搜索查询某一个服务或多个服务的列表,并返回服务相关的域名、时间等信息。
func (*Client) DescribeUsagePlan ¶
func (c *Client) DescribeUsagePlan(request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)
本接口(DescribeUsagePlan)用于查询一个使用计划的详细信息,包括名称、QPS、创建时间绑定的环境等。
func (*Client) DescribeUsagePlanEnvironments ¶
func (c *Client) DescribeUsagePlanEnvironments(request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)
本接口(DescribeUsagePlanEnvironments)用于查询使用计划绑定的环境列表。 用户在绑定了某个使用计划到环境后,可使用本接口查询这个使用计划绑定的所有服务的环境。
func (*Client) DescribeUsagePlanSecretIds ¶
func (c *Client) DescribeUsagePlanSecretIds(request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
本接口(DescribeUsagePlanSecretIds)用于查询使用计划绑定的密钥列表。 在 API 网关中,一个使用计划可绑定多个密钥对,可使用本接口查询使用计划绑定的密钥列表。
func (*Client) DescribeUsagePlansStatus ¶
func (c *Client) DescribeUsagePlansStatus(request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
本接口(DescribeUsagePlanStatus)用于查询使用计划的列表。
func (*Client) DisableApiKey ¶
func (c *Client) DisableApiKey(request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
本接口(DisableApiKey)用于禁用一对 API 密钥。
func (*Client) EnableApiKey ¶
func (c *Client) EnableApiKey(request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
本接口(EnableApiKey)用于启动一对被禁用的 API 密钥。
func (*Client) GenerateApiDocument ¶
func (c *Client) GenerateApiDocument(request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
本接口(GenerateApiDocument)用于自动生成 API 文档和 SDK,一个服务的一个环境生成一份文档和 SDK。
func (*Client) ModifyAPIDoc ¶
func (c *Client) ModifyAPIDoc(request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
修改 API 文档
func (*Client) ModifyApi ¶
func (c *Client) ModifyApi(request *ModifyApiRequest) (response *ModifyApiResponse, err error)
本接口(ModifyApi)用于修改 API 接口,可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。
func (*Client) ModifyApiEnvironmentStrategy ¶
func (c *Client) ModifyApiEnvironmentStrategy(request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
本接口(ModifyApiEnvironmentStrategy)用于修改API限流策略
func (*Client) ModifyApiIncrement ¶
func (c *Client) ModifyApiIncrement(request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
提供增量更新API能力,主要是给程序调用(区别于ModifyApi,该接口是需要传入API的全量参数,对console使用较友好)
func (*Client) ModifyIPStrategy ¶
func (c *Client) ModifyIPStrategy(request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
本接口(ModifyIPStrategy)用于修改服务IP策略。
func (*Client) ModifyService ¶
func (c *Client) ModifyService(request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)
本接口(ModifyService)用于修改服务的相关信息。当服务创建后,服务的名称、描述和服务类型均可被修改。
func (*Client) ModifyServiceEnvironmentStrategy ¶
func (c *Client) ModifyServiceEnvironmentStrategy(request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)
本接口(ModifyServiceEnvironmentStrategy)用于修改服务限流策略
func (*Client) ModifySubDomain ¶
func (c *Client) ModifySubDomain(request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
本接口(ModifySubDomain)用于修改服务的自定义域名设置中的路径映射,可以修改绑定自定义域名之前的路径映射规则。
func (*Client) ModifyUsagePlan ¶
func (c *Client) ModifyUsagePlan(request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
本接口(ModifyUsagePlan)用于修改使用计划的名称,描述及 QPS。
func (*Client) ReleaseService ¶
func (c *Client) ReleaseService(request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
本接口(ReleaseService)用于发布服务。 API 网关的服务创建后,需要发布到某个环境方生效后,使用者才能进行调用,此接口用于发布服务到环境,如 release 环境。
func (*Client) ResetAPIDocPassword ¶
func (c *Client) ResetAPIDocPassword(request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
重置API文档密码
func (*Client) UnBindEnvironment ¶
func (c *Client) UnBindEnvironment(request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
本接口(UnBindEnvironment)用于将使用计划从特定环境解绑。
func (*Client) UnBindIPStrategy ¶
func (c *Client) UnBindIPStrategy(request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
本接口(UnBindIPStrategy)用于服务解绑IP策略。
func (*Client) UnBindSecretIds ¶
func (c *Client) UnBindSecretIds(request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
本接口(UnBindSecretIds)用于为使用计划解绑密钥。
func (*Client) UnBindSubDomain ¶
func (c *Client) UnBindSubDomain(request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
本接口(UnBindSubDomain)用于解绑自定义域名。 用户使用 API 网关绑定了自定义域名到服务中后,若想要解绑此自定义域名,可使用此接口。
func (*Client) UnReleaseService ¶
func (c *Client) UnReleaseService(request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
本接口(UnReleaseService)用于下线服务。 用户发布服务到某个环境后,此服务中的 API 方可被调用者进行调用,当用户需要将此服务从发布环境中下线时,可调用此 API。下线后的服务不可被调用。
func (*Client) UpdateApiKey ¶
func (c *Client) UpdateApiKey(request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
本接口(UpdateApiKey)用于更换用户已创建的一对 API 密钥。
func (*Client) UpdateService ¶
func (c *Client) UpdateService(request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
本接口(UpdateService)用于从服务发布的环境中运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后,多因为开发过程会产生多个版本,此时可调用本接口。
type ConstantParameter ¶
type ConstantParameter struct {
// 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
Name *string `json:"Name,omitempty" name:"Name"`
// 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。
Desc *string `json:"Desc,omitempty" name:"Desc"`
// 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。
Position *string `json:"Position,omitempty" name:"Position"`
// 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`
}
type CreateAPIDocRequest ¶
type CreateAPIDocRequest struct {
*tchttp.BaseRequest
// API文档名称
ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"`
// 服务名称
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境名称
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 生成文档的API列表
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewCreateAPIDocRequest ¶
func NewCreateAPIDocRequest() (request *CreateAPIDocRequest)
func (*CreateAPIDocRequest) FromJsonString ¶
func (r *CreateAPIDocRequest) FromJsonString(s string) error
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 CreateAPIDocResponse ¶
type CreateAPIDocResponse struct {
*tchttp.BaseResponse
Response *struct {
// API文档基本信息
Result *APIDoc `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateAPIDocResponse ¶
func NewCreateAPIDocResponse() (response *CreateAPIDocResponse)
func (*CreateAPIDocResponse) FromJsonString ¶
func (r *CreateAPIDocResponse) FromJsonString(s string) error
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 CreateApiKeyRequest ¶
type CreateApiKeyRequest struct {
*tchttp.BaseRequest
// 用户自定义密钥名称。
SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
// 密钥类型,支持 auto 和 manual(自定义密钥),默认为 auto。
AccessKeyType *string `json:"AccessKeyType,omitempty" name:"AccessKeyType"`
// 用户自定义密钥 ID,AccessKeyType 为 manual 时必传。长度为5 - 50字符,由字母、数字、英文下划线组成。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
// 用户自定义密钥 Key,AccessKeyType 为 manual 时必传。长度为10 - 50字符,由字母、数字、英文下划线。
AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"`
}
func NewCreateApiKeyRequest ¶
func NewCreateApiKeyRequest() (request *CreateApiKeyRequest)
func (*CreateApiKeyRequest) FromJsonString ¶
func (r *CreateApiKeyRequest) FromJsonString(s string) error
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 CreateApiKeyResponse ¶
type CreateApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 新增的密钥详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiKey `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateApiKeyResponse ¶
func NewCreateApiKeyResponse() (response *CreateApiKeyResponse)
func (*CreateApiKeyResponse) FromJsonString ¶
func (r *CreateApiKeyResponse) FromJsonString(s string) error
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 CreateApiRequest ¶
type CreateApiRequest struct {
*tchttp.BaseRequest
// API 所在的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、WEBSOCKET、TARGET(内测)。
ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"`
// API 的后端服务超时时间,单位是秒。
ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"`
// API 的前端请求协议,支持HTTP和WEBSOCKET。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 请求的前端配置。
RequestConfig *ApiRequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"`
// 用户自定义的 API 名称。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// 用户自定义的 API 接口描述。
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// API 类型,支持NORMAL(普通API)和TSF(微服务API),默认为NORMAL。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API 鉴权类型。支持SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、APP(应用认证)。默认为NONE。
AuthType *string `json:"AuthType,omitempty" name:"AuthType"`
// 是否开启跨域。
EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"`
// 常量参数。
ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters" list`
// 前端请求参数。
RequestParameters []*RequestParameter `json:"RequestParameters,omitempty" name:"RequestParameters" list`
// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"`
// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"`
// API绑定微服务服务列表。
MicroServices []*MicroServiceReq `json:"MicroServices,omitempty" name:"MicroServices" list`
// 微服务的负载均衡配置。
ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"`
// 微服务的健康检查配置。
ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"`
// target类型后端资源信息。(内测阶段)
TargetServices []*TargetServicesReq `json:"TargetServices,omitempty" name:"TargetServices" list`
// target类型负载均衡配置。(内测阶段)
TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitempty" name:"TargetServicesLoadBalanceConf"`
// target健康检查配置。(内测阶段)
TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitempty" name:"TargetServicesHealthCheckConf"`
// scf 函数名称。当后端类型是SCF时生效。
ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"`
// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"`
// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"`
// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"`
// scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"`
// scf函数版本。当后端类型是SCF时生效。
ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"`
// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`
// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`
// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`
// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`
// 是否开启响应集成。当后端类型是SCF时生效。
ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"`
// 开始调试后计费。(云市场预留字段)
IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"`
// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitempty" name:"IsDeleteResponseErrorCodes"`
// 返回类型。
ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"`
// 自定义响应配置成功响应示例。
ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"`
// 自定义响应配置失败响应示例。
ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"`
// API 的后端服务配置。
ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"`
// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"`
// API的后端服务参数。
ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters" list`
// oauth配置。当AuthType是OAUTH时生效。
OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"`
// 用户自定义错误码配置。
ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes" list`
// tsf serverless 命名空间ID。(内测中)
TargetNamespaceId *string `json:"TargetNamespaceId,omitempty" name:"TargetNamespaceId"`
// 用户类型。
UserType *string `json:"UserType,omitempty" name:"UserType"`
// 是否打开Base64编码,只有后端是scf时才会生效。
IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"`
}
func NewCreateApiRequest ¶
func NewCreateApiRequest() (request *CreateApiRequest)
func (*CreateApiRequest) FromJsonString ¶
func (r *CreateApiRequest) FromJsonString(s string) error
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 CreateApiResponse ¶
type CreateApiResponse struct {
*tchttp.BaseResponse
Response *struct {
// api信息
// 注意:此字段可能返回 null,表示取不到有效值。
Result *CreateApiRsp `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateApiResponse ¶
func NewCreateApiResponse() (response *CreateApiResponse)
func (*CreateApiResponse) FromJsonString ¶
func (r *CreateApiResponse) FromJsonString(s string) error
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 CreateApiRsp ¶
type CreateApiRsp struct {
// api id
// 注意:此字段可能返回 null,表示取不到有效值。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// path
// 注意:此字段可能返回 null,表示取不到有效值。
Path *string `json:"Path,omitempty" name:"Path"`
// method
// 注意:此字段可能返回 null,表示取不到有效值。
Method *string `json:"Method,omitempty" name:"Method"`
// 创建时间
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
}
type CreateIPStrategyRequest ¶
type CreateIPStrategyRequest struct {
*tchttp.BaseRequest
// 服务的唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 用户自定义的策略名称。
StrategyName *string `json:"StrategyName,omitempty" name:"StrategyName"`
// 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
StrategyType *string `json:"StrategyType,omitempty" name:"StrategyType"`
// 策略详情,多个ip 使用\n 分隔符分开。
StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"`
}
func NewCreateIPStrategyRequest ¶
func NewCreateIPStrategyRequest() (request *CreateIPStrategyRequest)
func (*CreateIPStrategyRequest) FromJsonString ¶
func (r *CreateIPStrategyRequest) FromJsonString(s string) error
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 CreateIPStrategyResponse ¶
type CreateIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 新建的IP策略详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *IPStrategy `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateIPStrategyResponse ¶
func NewCreateIPStrategyResponse() (response *CreateIPStrategyResponse)
func (*CreateIPStrategyResponse) FromJsonString ¶
func (r *CreateIPStrategyResponse) FromJsonString(s string) error
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 CreateServiceRequest ¶
type CreateServiceRequest struct {
*tchttp.BaseRequest
// 用户自定义的服务名称。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 服务的前端请求类型。如 http、https、http&https。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 用户自定义的服务描述。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// 独立集群名称,用于指定创建服务所在的独立集群。
ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"`
// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes" list`
// IP版本号,支持IPv4和IPv6,默认为IPv4。
IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"`
// 集群名称。保留字段,tsf serverlss类型使用。
SetServerName *string `json:"SetServerName,omitempty" name:"SetServerName"`
// 用户类型。保留类型,serverless用户使用。
AppIdType *string `json:"AppIdType,omitempty" name:"AppIdType"`
// 标签。
Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`
// 独享实例id
InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}
func NewCreateServiceRequest ¶
func NewCreateServiceRequest() (request *CreateServiceRequest)
func (*CreateServiceRequest) FromJsonString ¶
func (r *CreateServiceRequest) FromJsonString(s string) error
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 CreateServiceResponse ¶
type CreateServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 用户自定义服务名称。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 用户自定义服务描述。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// 外网默认域名。
OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"`
// vpc内网默认域名。
InnerSubDomain *string `json:"InnerSubDomain,omitempty" name:"InnerSubDomain"`
// 服务创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 网络类型列表,INNER为内网访问,OUTER为外网访问。
NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes" list`
// IP版本号。
// 注意:此字段可能返回 null,表示取不到有效值。
IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateServiceResponse ¶
func NewCreateServiceResponse() (response *CreateServiceResponse)
func (*CreateServiceResponse) FromJsonString ¶
func (r *CreateServiceResponse) FromJsonString(s string) error
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 CreateUsagePlanRequest ¶
type CreateUsagePlanRequest struct {
*tchttp.BaseRequest
// 用户自定义的使用计划名称。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 用户自定义的使用计划描述。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
}
func NewCreateUsagePlanRequest ¶
func NewCreateUsagePlanRequest() (request *CreateUsagePlanRequest)
func (*CreateUsagePlanRequest) FromJsonString ¶
func (r *CreateUsagePlanRequest) FromJsonString(s string) error
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 CreateUsagePlanResponse ¶
type CreateUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateUsagePlanResponse ¶
func NewCreateUsagePlanResponse() (response *CreateUsagePlanResponse)
func (*CreateUsagePlanResponse) FromJsonString ¶
func (r *CreateUsagePlanResponse) FromJsonString(s string) error
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 DeleteAPIDocRequest ¶
type DeleteAPIDocRequest struct {
*tchttp.BaseRequest
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
}
func NewDeleteAPIDocRequest ¶
func NewDeleteAPIDocRequest() (request *DeleteAPIDocRequest)
func (*DeleteAPIDocRequest) FromJsonString ¶
func (r *DeleteAPIDocRequest) FromJsonString(s string) error
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 DeleteAPIDocResponse ¶
type DeleteAPIDocResponse struct {
*tchttp.BaseResponse
Response *struct {
// 操作是否成功
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteAPIDocResponse ¶
func NewDeleteAPIDocResponse() (response *DeleteAPIDocResponse)
func (*DeleteAPIDocResponse) FromJsonString ¶
func (r *DeleteAPIDocResponse) FromJsonString(s string) error
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 DeleteApiKeyRequest ¶
type DeleteApiKeyRequest struct {
*tchttp.BaseRequest
// 待删除的密钥 ID。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
}
func NewDeleteApiKeyRequest ¶
func NewDeleteApiKeyRequest() (request *DeleteApiKeyRequest)
func (*DeleteApiKeyRequest) FromJsonString ¶
func (r *DeleteApiKeyRequest) FromJsonString(s string) error
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 DeleteApiKeyResponse ¶
type DeleteApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteApiKeyResponse ¶
func NewDeleteApiKeyResponse() (response *DeleteApiKeyResponse)
func (*DeleteApiKeyResponse) FromJsonString ¶
func (r *DeleteApiKeyResponse) FromJsonString(s string) error
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 DeleteApiRequest ¶
type DeleteApiRequest struct {
*tchttp.BaseRequest
// API 所在的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 接口唯一 ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
}
func NewDeleteApiRequest ¶
func NewDeleteApiRequest() (request *DeleteApiRequest)
func (*DeleteApiRequest) FromJsonString ¶
func (r *DeleteApiRequest) FromJsonString(s string) error
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 DeleteApiResponse ¶
type DeleteApiResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteApiResponse ¶
func NewDeleteApiResponse() (response *DeleteApiResponse)
func (*DeleteApiResponse) FromJsonString ¶
func (r *DeleteApiResponse) FromJsonString(s string) error
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 DeleteIPStrategyRequest ¶
type DeleteIPStrategyRequest struct {
*tchttp.BaseRequest
// 待删除的IP策略所属的服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待删除的IP策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
}
func NewDeleteIPStrategyRequest ¶
func NewDeleteIPStrategyRequest() (request *DeleteIPStrategyRequest)
func (*DeleteIPStrategyRequest) FromJsonString ¶
func (r *DeleteIPStrategyRequest) FromJsonString(s string) error
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 DeleteIPStrategyResponse ¶
type DeleteIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteIPStrategyResponse ¶
func NewDeleteIPStrategyResponse() (response *DeleteIPStrategyResponse)
func (*DeleteIPStrategyResponse) FromJsonString ¶
func (r *DeleteIPStrategyResponse) FromJsonString(s string) error
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 DeleteServiceRequest ¶
type DeleteServiceRequest struct {
*tchttp.BaseRequest
// 待删除服务的唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
}
func NewDeleteServiceRequest ¶
func NewDeleteServiceRequest() (request *DeleteServiceRequest)
func (*DeleteServiceRequest) FromJsonString ¶
func (r *DeleteServiceRequest) FromJsonString(s string) error
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 DeleteServiceResponse ¶
type DeleteServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteServiceResponse ¶
func NewDeleteServiceResponse() (response *DeleteServiceResponse)
func (*DeleteServiceResponse) FromJsonString ¶
func (r *DeleteServiceResponse) FromJsonString(s string) error
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 DeleteServiceSubDomainMappingRequest ¶
type DeleteServiceSubDomainMappingRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 服务绑定的自定义域名。
SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"`
// 待删除映射的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
Environment *string `json:"Environment,omitempty" name:"Environment"`
}
func NewDeleteServiceSubDomainMappingRequest ¶
func NewDeleteServiceSubDomainMappingRequest() (request *DeleteServiceSubDomainMappingRequest)
func (*DeleteServiceSubDomainMappingRequest) FromJsonString ¶
func (r *DeleteServiceSubDomainMappingRequest) FromJsonString(s string) error
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 DeleteServiceSubDomainMappingResponse ¶
type DeleteServiceSubDomainMappingResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除自定义域名的路径映射操作是否成功。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteServiceSubDomainMappingResponse ¶
func NewDeleteServiceSubDomainMappingResponse() (response *DeleteServiceSubDomainMappingResponse)
func (*DeleteServiceSubDomainMappingResponse) FromJsonString ¶
func (r *DeleteServiceSubDomainMappingResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteServiceSubDomainMappingResponse) ToJsonString ¶
func (r *DeleteServiceSubDomainMappingResponse) ToJsonString() string
type DeleteUsagePlanRequest ¶
type DeleteUsagePlanRequest struct {
*tchttp.BaseRequest
// 待删除的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
}
func NewDeleteUsagePlanRequest ¶
func NewDeleteUsagePlanRequest() (request *DeleteUsagePlanRequest)
func (*DeleteUsagePlanRequest) FromJsonString ¶
func (r *DeleteUsagePlanRequest) FromJsonString(s string) error
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 DeleteUsagePlanResponse ¶
type DeleteUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 删除操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteUsagePlanResponse ¶
func NewDeleteUsagePlanResponse() (response *DeleteUsagePlanResponse)
func (*DeleteUsagePlanResponse) FromJsonString ¶
func (r *DeleteUsagePlanResponse) FromJsonString(s string) error
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 DemoteServiceUsagePlanRequest ¶
type DemoteServiceUsagePlanRequest struct {
*tchttp.BaseRequest
// 使用计划ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 待降级的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境名称。
Environment *string `json:"Environment,omitempty" name:"Environment"`
}
func NewDemoteServiceUsagePlanRequest ¶
func NewDemoteServiceUsagePlanRequest() (request *DemoteServiceUsagePlanRequest)
func (*DemoteServiceUsagePlanRequest) FromJsonString ¶
func (r *DemoteServiceUsagePlanRequest) FromJsonString(s string) error
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 DemoteServiceUsagePlanResponse ¶
type DemoteServiceUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 降级操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDemoteServiceUsagePlanResponse ¶
func NewDemoteServiceUsagePlanResponse() (response *DemoteServiceUsagePlanResponse)
func (*DemoteServiceUsagePlanResponse) FromJsonString ¶
func (r *DemoteServiceUsagePlanResponse) FromJsonString(s string) error
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 DesApisStatus ¶
type DesApisStatus struct {
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API唯一ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 用户自定义的 API 接口描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// API 接口的名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// VPCID。
// 注意:此字段可能返回 null,表示取不到有效值。
VpcId *int64 `json:"VpcId,omitempty" name:"VpcId"`
// VPC唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"`
// API类型。取值为NORMAL(普通API)和TSF(微服务API)。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API协议。
// 注意:此字段可能返回 null,表示取不到有效值。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 是否买后调试。(云市场预留字段)
// 注意:此字段可能返回 null,表示取不到有效值。
IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"`
// API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthType *string `json:"AuthType,omitempty" name:"AuthType"`
// OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"`
// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"`
// OAUTH 配置信息。当AuthType是OAUTH时生效。
// 注意:此字段可能返回 null,表示取不到有效值。
OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"`
// 授权API关联的业务API列表。
// 注意:此字段可能返回 null,表示取不到有效值。
RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitempty" name:"RelationBuniessApiIds" list`
// API关联的标签信息。
// 注意:此字段可能返回 null,表示取不到有效值。
Tags []*string `json:"Tags,omitempty" name:"Tags" list`
// API 的路径,如 /path。
// 注意:此字段可能返回 null,表示取不到有效值。
Path *string `json:"Path,omitempty" name:"Path"`
// API 的请求方法,如 GET。
// 注意:此字段可能返回 null,表示取不到有效值。
Method *string `json:"Method,omitempty" name:"Method"`
}
type DescribeAPIDocDetailRequest ¶
type DescribeAPIDocDetailRequest struct {
*tchttp.BaseRequest
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
}
func NewDescribeAPIDocDetailRequest ¶
func NewDescribeAPIDocDetailRequest() (request *DescribeAPIDocDetailRequest)
func (*DescribeAPIDocDetailRequest) FromJsonString ¶
func (r *DescribeAPIDocDetailRequest) FromJsonString(s string) error
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 DescribeAPIDocDetailResponse ¶
type DescribeAPIDocDetailResponse struct {
*tchttp.BaseResponse
Response *struct {
// API文档详细信息
Result *APIDocInfo `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeAPIDocDetailResponse ¶
func NewDescribeAPIDocDetailResponse() (response *DescribeAPIDocDetailResponse)
func (*DescribeAPIDocDetailResponse) FromJsonString ¶
func (r *DescribeAPIDocDetailResponse) FromJsonString(s string) error
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 DescribeAPIDocsRequest ¶
type DescribeAPIDocsRequest struct {
*tchttp.BaseRequest
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeAPIDocsRequest ¶
func NewDescribeAPIDocsRequest() (request *DescribeAPIDocsRequest)
func (*DescribeAPIDocsRequest) FromJsonString ¶
func (r *DescribeAPIDocsRequest) FromJsonString(s string) error
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 DescribeAPIDocsResponse ¶
type DescribeAPIDocsResponse struct {
*tchttp.BaseResponse
Response *struct {
// API文档列表信息
Result *APIDocs `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeAPIDocsResponse ¶
func NewDescribeAPIDocsResponse() (response *DescribeAPIDocsResponse)
func (*DescribeAPIDocsResponse) FromJsonString ¶
func (r *DescribeAPIDocsResponse) FromJsonString(s string) error
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 DescribeApiEnvironmentStrategyRequest ¶
type DescribeApiEnvironmentStrategyRequest struct {
*tchttp.BaseRequest
// API所属服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境列表。
EnvironmentNames []*string `json:"EnvironmentNames,omitempty" name:"EnvironmentNames" list`
// API唯一ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeApiEnvironmentStrategyRequest ¶
func NewDescribeApiEnvironmentStrategyRequest() (request *DescribeApiEnvironmentStrategyRequest)
func (*DescribeApiEnvironmentStrategyRequest) FromJsonString ¶
func (r *DescribeApiEnvironmentStrategyRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiEnvironmentStrategyRequest) ToJsonString ¶
func (r *DescribeApiEnvironmentStrategyRequest) ToJsonString() string
type DescribeApiEnvironmentStrategyResponse ¶
type DescribeApiEnvironmentStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// api绑定策略详情
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiEnvironmentStrategyStataus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApiEnvironmentStrategyResponse ¶
func NewDescribeApiEnvironmentStrategyResponse() (response *DescribeApiEnvironmentStrategyResponse)
func (*DescribeApiEnvironmentStrategyResponse) FromJsonString ¶
func (r *DescribeApiEnvironmentStrategyResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiEnvironmentStrategyResponse) ToJsonString ¶
func (r *DescribeApiEnvironmentStrategyResponse) ToJsonString() string
type DescribeApiKeyRequest ¶
type DescribeApiKeyRequest struct {
*tchttp.BaseRequest
// API 密钥 ID。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
}
func NewDescribeApiKeyRequest ¶
func NewDescribeApiKeyRequest() (request *DescribeApiKeyRequest)
func (*DescribeApiKeyRequest) FromJsonString ¶
func (r *DescribeApiKeyRequest) FromJsonString(s string) error
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 DescribeApiKeyResponse ¶
type DescribeApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 密钥详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiKey `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApiKeyResponse ¶
func NewDescribeApiKeyResponse() (response *DescribeApiKeyResponse)
func (*DescribeApiKeyResponse) FromJsonString ¶
func (r *DescribeApiKeyResponse) FromJsonString(s string) error
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 DescribeApiKeysStatusRequest ¶
type DescribeApiKeysStatusRequest struct {
*tchttp.BaseRequest
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 过滤条件。支持AccessKeyId、AccessKeySecret、SecretName、NotUsagePlanId、Status、KeyWord( 可以匹配name或者path)。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeApiKeysStatusRequest ¶
func NewDescribeApiKeysStatusRequest() (request *DescribeApiKeysStatusRequest)
func (*DescribeApiKeysStatusRequest) FromJsonString ¶
func (r *DescribeApiKeysStatusRequest) FromJsonString(s string) error
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 DescribeApiKeysStatusResponse ¶
type DescribeApiKeysStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// 密钥列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiKeysStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApiKeysStatusResponse ¶
func NewDescribeApiKeysStatusResponse() (response *DescribeApiKeysStatusResponse)
func (*DescribeApiKeysStatusResponse) FromJsonString ¶
func (r *DescribeApiKeysStatusResponse) FromJsonString(s string) error
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 DescribeApiRequest ¶
type DescribeApiRequest struct {
*tchttp.BaseRequest
// API 所在的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 接口唯一 ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
}
func NewDescribeApiRequest ¶
func NewDescribeApiRequest() (request *DescribeApiRequest)
func (*DescribeApiRequest) FromJsonString ¶
func (r *DescribeApiRequest) FromJsonString(s string) error
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 DescribeApiResponse ¶
type DescribeApiResponse struct {
*tchttp.BaseResponse
Response *struct {
// API 详情。
Result *ApiInfo `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApiResponse ¶
func NewDescribeApiResponse() (response *DescribeApiResponse)
func (*DescribeApiResponse) FromJsonString ¶
func (r *DescribeApiResponse) FromJsonString(s string) error
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 DescribeApiUsagePlanRequest ¶
type DescribeApiUsagePlanRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeApiUsagePlanRequest ¶
func NewDescribeApiUsagePlanRequest() (request *DescribeApiUsagePlanRequest)
func (*DescribeApiUsagePlanRequest) FromJsonString ¶
func (r *DescribeApiUsagePlanRequest) FromJsonString(s string) error
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 DescribeApiUsagePlanResponse ¶
type DescribeApiUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// api绑定使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiUsagePlanSet `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApiUsagePlanResponse ¶
func NewDescribeApiUsagePlanResponse() (response *DescribeApiUsagePlanResponse)
func (*DescribeApiUsagePlanResponse) FromJsonString ¶
func (r *DescribeApiUsagePlanResponse) FromJsonString(s string) error
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 DescribeApisStatusRequest ¶
type DescribeApisStatusRequest struct {
*tchttp.BaseRequest
// API 所在的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 返回数量,默认为 20,最大值为 100
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys (values 为 tag key的列表)。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeApisStatusRequest ¶
func NewDescribeApisStatusRequest() (request *DescribeApisStatusRequest)
func (*DescribeApisStatusRequest) FromJsonString ¶
func (r *DescribeApisStatusRequest) FromJsonString(s string) error
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 DescribeApisStatusResponse ¶
type DescribeApisStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// API 详情列表。
Result *ApisStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeApisStatusResponse ¶
func NewDescribeApisStatusResponse() (response *DescribeApisStatusResponse)
func (*DescribeApisStatusResponse) FromJsonString ¶
func (r *DescribeApisStatusResponse) FromJsonString(s string) error
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 DescribeIPStrategyApisStatusRequest ¶
type DescribeIPStrategyApisStatusRequest struct {
*tchttp.BaseRequest
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// 策略所在环境。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 过滤条件。支持 ApiPath、ApiName、KeyWord(模糊查询Path 和Name)。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeIPStrategyApisStatusRequest ¶
func NewDescribeIPStrategyApisStatusRequest() (request *DescribeIPStrategyApisStatusRequest)
func (*DescribeIPStrategyApisStatusRequest) FromJsonString ¶
func (r *DescribeIPStrategyApisStatusRequest) FromJsonString(s string) error
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 DescribeIPStrategyApisStatusResponse ¶
type DescribeIPStrategyApisStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// 环境绑定API列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *IPStrategyApiStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeIPStrategyApisStatusResponse ¶
func NewDescribeIPStrategyApisStatusResponse() (response *DescribeIPStrategyApisStatusResponse)
func (*DescribeIPStrategyApisStatusResponse) FromJsonString ¶
func (r *DescribeIPStrategyApisStatusResponse) FromJsonString(s string) error
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 DescribeIPStrategyRequest ¶
type DescribeIPStrategyRequest struct {
*tchttp.BaseRequest
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// IP 策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// 策略关联的环境。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 过滤条件。预留字段,目前不支持过滤。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeIPStrategyRequest ¶
func NewDescribeIPStrategyRequest() (request *DescribeIPStrategyRequest)
func (*DescribeIPStrategyRequest) FromJsonString ¶
func (r *DescribeIPStrategyRequest) FromJsonString(s string) error
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 DescribeIPStrategyResponse ¶
type DescribeIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// IP策略详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *IPStrategy `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeIPStrategyResponse ¶
func NewDescribeIPStrategyResponse() (response *DescribeIPStrategyResponse)
func (*DescribeIPStrategyResponse) FromJsonString ¶
func (r *DescribeIPStrategyResponse) FromJsonString(s string) error
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 DescribeIPStrategysStatusRequest ¶
type DescribeIPStrategysStatusRequest struct {
*tchttp.BaseRequest
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 过滤条件。支持StrategyName。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeIPStrategysStatusRequest ¶
func NewDescribeIPStrategysStatusRequest() (request *DescribeIPStrategysStatusRequest)
func (*DescribeIPStrategysStatusRequest) FromJsonString ¶
func (r *DescribeIPStrategysStatusRequest) FromJsonString(s string) error
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 DescribeIPStrategysStatusResponse ¶
type DescribeIPStrategysStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// 符合条件的策略列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *IPStrategysStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeIPStrategysStatusResponse ¶
func NewDescribeIPStrategysStatusResponse() (response *DescribeIPStrategysStatusResponse)
func (*DescribeIPStrategysStatusResponse) FromJsonString ¶
func (r *DescribeIPStrategysStatusResponse) FromJsonString(s string) error
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 DescribeLogSearchRequest ¶
type DescribeLogSearchRequest struct {
*tchttp.BaseRequest
// 日志开始时间
StartTime *string `json:"StartTime,omitempty" name:"StartTime"`
// 日志结束时间
EndTime *string `json:"EndTime,omitempty" name:"EndTime"`
// 服务id
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 保留字段
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
// 单次要返回的日志条数,单次返回的最大条数为100
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 根据上次返回的ConText,获取后续的内容,最多可获取10000条
ConText *string `json:"ConText,omitempty" name:"ConText"`
// 按时间排序 asc(升序)或者 desc(降序),默认为 desc
Sort *string `json:"Sort,omitempty" name:"Sort"`
// 保留字段
Query *string `json:"Query,omitempty" name:"Query"`
// 检索条件,支持的检索条件如下:
// req_id:“=”
// api_id:“=”
// cip:“=”
// uip:“:”
// err_msg:“:”
// rsp_st:“=” 、“!=” 、 “:” 、 “>” 、 “<”
// req_t:”>=“ 、 ”<=“
//
// 说明:
// “:”表示包含,“!=”表示不等于,字段含义见输出参数的LogSet说明
LogQuerys []*LogQuery `json:"LogQuerys,omitempty" name:"LogQuerys" list`
}
func NewDescribeLogSearchRequest ¶
func NewDescribeLogSearchRequest() (request *DescribeLogSearchRequest)
func (*DescribeLogSearchRequest) FromJsonString ¶
func (r *DescribeLogSearchRequest) FromJsonString(s string) error
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 DescribeLogSearchResponse ¶
type DescribeLogSearchResponse struct {
*tchttp.BaseResponse
Response *struct {
// 获取更多检索结果的游标,值为""表示无后续结果
ConText *string `json:"ConText,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,omitempty" name:"LogSet" list`
// 单次搜索返回的日志条数,TotalCount <= Limit
TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeLogSearchResponse ¶
func NewDescribeLogSearchResponse() (response *DescribeLogSearchResponse)
func (*DescribeLogSearchResponse) FromJsonString ¶
func (r *DescribeLogSearchResponse) FromJsonString(s string) error
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 DescribePluginsRequest ¶
type DescribePluginsRequest struct {
*tchttp.BaseRequest
// 要查询的插件列表。
PluginIds []*string `json:"PluginIds,omitempty" name:"PluginIds" list`
// 要查询的插件名称。
PluginName *string `json:"PluginName,omitempty" name:"PluginName"`
// 要查询的插件类型。
PluginType *string `json:"PluginType,omitempty" name:"PluginType"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 过滤条件。预留字段,目前不支持过滤。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribePluginsRequest ¶
func NewDescribePluginsRequest() (request *DescribePluginsRequest)
func (*DescribePluginsRequest) FromJsonString ¶
func (r *DescribePluginsRequest) FromJsonString(s string) error
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 DescribePluginsResponse ¶
type DescribePluginsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 插件详情。
Result *PluginSummary `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribePluginsResponse ¶
func NewDescribePluginsResponse() (response *DescribePluginsResponse)
func (*DescribePluginsResponse) FromJsonString ¶
func (r *DescribePluginsResponse) FromJsonString(s string) error
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 DescribeServiceEnvironmentListRequest ¶
type DescribeServiceEnvironmentListRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为 20,最大值为 100。
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceEnvironmentListRequest ¶
func NewDescribeServiceEnvironmentListRequest() (request *DescribeServiceEnvironmentListRequest)
func (*DescribeServiceEnvironmentListRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentListRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentListRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentListRequest) ToJsonString() string
type DescribeServiceEnvironmentListResponse ¶
type DescribeServiceEnvironmentListResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务绑定环境详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServiceEnvironmentSet `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceEnvironmentListResponse ¶
func NewDescribeServiceEnvironmentListResponse() (response *DescribeServiceEnvironmentListResponse)
func (*DescribeServiceEnvironmentListResponse) FromJsonString ¶
func (r *DescribeServiceEnvironmentListResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentListResponse) ToJsonString ¶
func (r *DescribeServiceEnvironmentListResponse) ToJsonString() string
type DescribeServiceEnvironmentReleaseHistoryRequest ¶
type DescribeServiceEnvironmentReleaseHistoryRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境名称。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceEnvironmentReleaseHistoryRequest ¶
func NewDescribeServiceEnvironmentReleaseHistoryRequest() (request *DescribeServiceEnvironmentReleaseHistoryRequest)
func (*DescribeServiceEnvironmentReleaseHistoryRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentReleaseHistoryRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryRequest) ToJsonString() string
type DescribeServiceEnvironmentReleaseHistoryResponse ¶
type DescribeServiceEnvironmentReleaseHistoryResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务发布历史。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServiceReleaseHistory `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceEnvironmentReleaseHistoryResponse ¶
func NewDescribeServiceEnvironmentReleaseHistoryResponse() (response *DescribeServiceEnvironmentReleaseHistoryResponse)
func (*DescribeServiceEnvironmentReleaseHistoryResponse) FromJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentReleaseHistoryResponse) ToJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryResponse) ToJsonString() string
type DescribeServiceEnvironmentStrategyRequest ¶
type DescribeServiceEnvironmentStrategyRequest struct {
*tchttp.BaseRequest
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceEnvironmentStrategyRequest ¶
func NewDescribeServiceEnvironmentStrategyRequest() (request *DescribeServiceEnvironmentStrategyRequest)
func (*DescribeServiceEnvironmentStrategyRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentStrategyRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentStrategyRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentStrategyRequest) ToJsonString() string
type DescribeServiceEnvironmentStrategyResponse ¶
type DescribeServiceEnvironmentStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 限流策略列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServiceEnvironmentStrategyStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceEnvironmentStrategyResponse ¶
func NewDescribeServiceEnvironmentStrategyResponse() (response *DescribeServiceEnvironmentStrategyResponse)
func (*DescribeServiceEnvironmentStrategyResponse) FromJsonString ¶
func (r *DescribeServiceEnvironmentStrategyResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentStrategyResponse) ToJsonString ¶
func (r *DescribeServiceEnvironmentStrategyResponse) ToJsonString() string
type DescribeServiceReleaseVersionRequest ¶
type DescribeServiceReleaseVersionRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为 20,最大值为 100。
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为0。
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceReleaseVersionRequest ¶
func NewDescribeServiceReleaseVersionRequest() (request *DescribeServiceReleaseVersionRequest)
func (*DescribeServiceReleaseVersionRequest) FromJsonString ¶
func (r *DescribeServiceReleaseVersionRequest) FromJsonString(s string) error
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 DescribeServiceReleaseVersionResponse ¶
type DescribeServiceReleaseVersionResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务发布版本列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServiceReleaseVersion `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceReleaseVersionResponse ¶
func NewDescribeServiceReleaseVersionResponse() (response *DescribeServiceReleaseVersionResponse)
func (*DescribeServiceReleaseVersionResponse) FromJsonString ¶
func (r *DescribeServiceReleaseVersionResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceReleaseVersionResponse) ToJsonString ¶
func (r *DescribeServiceReleaseVersionResponse) ToJsonString() string
type DescribeServiceRequest ¶
type DescribeServiceRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
}
func NewDescribeServiceRequest ¶
func NewDescribeServiceRequest() (request *DescribeServiceRequest)
func (*DescribeServiceRequest) FromJsonString ¶
func (r *DescribeServiceRequest) FromJsonString(s string) error
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 DescribeServiceResponse ¶
type DescribeServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 服务 环境列表。
AvailableEnvironments []*string `json:"AvailableEnvironments,omitempty" name:"AvailableEnvironments" list`
// 服务名称。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 服务描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// 服务支持协议,可选值为http、https、http&https。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 服务创建时间。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 服务修改时间。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 独立集群名称。
ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"`
// 网络类型列表,INNER为内网访问,OUTER为外网访问。
NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes" list`
// 内网访问子域名。
InternalSubDomain *string `json:"InternalSubDomain,omitempty" name:"InternalSubDomain"`
// 外网访问子域名。
OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"`
// 内网访问http服务端口号。
InnerHttpPort *int64 `json:"InnerHttpPort,omitempty" name:"InnerHttpPort"`
// 内网访问https端口号。
InnerHttpsPort *int64 `json:"InnerHttpsPort,omitempty" name:"InnerHttpsPort"`
// API总数。
ApiTotalCount *int64 `json:"ApiTotalCount,omitempty" name:"ApiTotalCount"`
// API列表。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiIdStatusSet []*ApiIdStatus `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet" list`
// 使用计划总数量。
UsagePlanTotalCount *int64 `json:"UsagePlanTotalCount,omitempty" name:"UsagePlanTotalCount"`
// 使用计划数组。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanList []*UsagePlan `json:"UsagePlanList,omitempty" name:"UsagePlanList" list`
// IP版本。
// 注意:此字段可能返回 null,表示取不到有效值。
IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"`
// 此服务的用户类型。
// 注意:此字段可能返回 null,表示取不到有效值。
UserType *string `json:"UserType,omitempty" name:"UserType"`
// 预留字段。
// 注意:此字段可能返回 null,表示取不到有效值。
SetId *int64 `json:"SetId,omitempty" name:"SetId"`
// 服务绑定的标签。
// 注意:此字段可能返回 null,表示取不到有效值。
Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`
// 独享实例id
// 注意:此字段可能返回 null,表示取不到有效值。
InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
// 独享实例name
// 注意:此字段可能返回 null,表示取不到有效值。
InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`
// 集群类型
// 注意:此字段可能返回 null,表示取不到有效值。
SetType *string `json:"SetType,omitempty" name:"SetType"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceResponse ¶
func NewDescribeServiceResponse() (response *DescribeServiceResponse)
func (*DescribeServiceResponse) FromJsonString ¶
func (r *DescribeServiceResponse) FromJsonString(s string) error
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 DescribeServiceSubDomainMappingsRequest ¶
type DescribeServiceSubDomainMappingsRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 服务绑定的自定义域名。
SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"`
}
func NewDescribeServiceSubDomainMappingsRequest ¶
func NewDescribeServiceSubDomainMappingsRequest() (request *DescribeServiceSubDomainMappingsRequest)
func (*DescribeServiceSubDomainMappingsRequest) FromJsonString ¶
func (r *DescribeServiceSubDomainMappingsRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceSubDomainMappingsRequest) ToJsonString ¶
func (r *DescribeServiceSubDomainMappingsRequest) ToJsonString() string
type DescribeServiceSubDomainMappingsResponse ¶
type DescribeServiceSubDomainMappingsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 自定义路径映射列表。
Result *ServiceSubDomainMappings `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceSubDomainMappingsResponse ¶
func NewDescribeServiceSubDomainMappingsResponse() (response *DescribeServiceSubDomainMappingsResponse)
func (*DescribeServiceSubDomainMappingsResponse) FromJsonString ¶
func (r *DescribeServiceSubDomainMappingsResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceSubDomainMappingsResponse) ToJsonString ¶
func (r *DescribeServiceSubDomainMappingsResponse) ToJsonString() string
type DescribeServiceSubDomainsRequest ¶
type DescribeServiceSubDomainsRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceSubDomainsRequest ¶
func NewDescribeServiceSubDomainsRequest() (request *DescribeServiceSubDomainsRequest)
func (*DescribeServiceSubDomainsRequest) FromJsonString ¶
func (r *DescribeServiceSubDomainsRequest) FromJsonString(s string) error
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 DescribeServiceSubDomainsResponse ¶
type DescribeServiceSubDomainsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 查询服务自定义域名列表。
Result *DomainSets `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceSubDomainsResponse ¶
func NewDescribeServiceSubDomainsResponse() (response *DescribeServiceSubDomainsResponse)
func (*DescribeServiceSubDomainsResponse) FromJsonString ¶
func (r *DescribeServiceSubDomainsResponse) FromJsonString(s string) error
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 DescribeServiceUsagePlanRequest ¶
type DescribeServiceUsagePlanRequest struct {
*tchttp.BaseRequest
// 待查询的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 返回数量,默认为20,最大值为100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeServiceUsagePlanRequest ¶
func NewDescribeServiceUsagePlanRequest() (request *DescribeServiceUsagePlanRequest)
func (*DescribeServiceUsagePlanRequest) FromJsonString ¶
func (r *DescribeServiceUsagePlanRequest) FromJsonString(s string) error
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 DescribeServiceUsagePlanResponse ¶
type DescribeServiceUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务绑定使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServiceUsagePlanSet `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServiceUsagePlanResponse ¶
func NewDescribeServiceUsagePlanResponse() (response *DescribeServiceUsagePlanResponse)
func (*DescribeServiceUsagePlanResponse) FromJsonString ¶
func (r *DescribeServiceUsagePlanResponse) FromJsonString(s string) error
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 DescribeServicesStatusRequest ¶
type DescribeServicesStatusRequest struct {
*tchttp.BaseRequest
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 过滤条件。支持ServiceId、ServiceName、NotUsagePlanId、Environment、IpVersion。InstanceId
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeServicesStatusRequest ¶
func NewDescribeServicesStatusRequest() (request *DescribeServicesStatusRequest)
func (*DescribeServicesStatusRequest) FromJsonString ¶
func (r *DescribeServicesStatusRequest) FromJsonString(s string) error
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 DescribeServicesStatusResponse ¶
type DescribeServicesStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// 服务列表查询结果。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ServicesStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeServicesStatusResponse ¶
func NewDescribeServicesStatusResponse() (response *DescribeServicesStatusResponse)
func (*DescribeServicesStatusResponse) FromJsonString ¶
func (r *DescribeServicesStatusResponse) FromJsonString(s string) error
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 DescribeUsagePlanEnvironmentsRequest ¶
type DescribeUsagePlanEnvironmentsRequest struct {
*tchttp.BaseRequest
// 待查询的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 定类型,取值为 API、SERVICE,默认值为 SERVICE。
BindType *string `json:"BindType,omitempty" name:"BindType"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeUsagePlanEnvironmentsRequest ¶
func NewDescribeUsagePlanEnvironmentsRequest() (request *DescribeUsagePlanEnvironmentsRequest)
func (*DescribeUsagePlanEnvironmentsRequest) FromJsonString ¶
func (r *DescribeUsagePlanEnvironmentsRequest) FromJsonString(s string) error
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 DescribeUsagePlanEnvironmentsResponse ¶
type DescribeUsagePlanEnvironmentsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划绑定详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlanEnvironmentStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeUsagePlanEnvironmentsResponse ¶
func NewDescribeUsagePlanEnvironmentsResponse() (response *DescribeUsagePlanEnvironmentsResponse)
func (*DescribeUsagePlanEnvironmentsResponse) FromJsonString ¶
func (r *DescribeUsagePlanEnvironmentsResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanEnvironmentsResponse) ToJsonString ¶
func (r *DescribeUsagePlanEnvironmentsResponse) ToJsonString() string
type DescribeUsagePlanRequest ¶
type DescribeUsagePlanRequest struct {
*tchttp.BaseRequest
// 待查询的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
}
func NewDescribeUsagePlanRequest ¶
func NewDescribeUsagePlanRequest() (request *DescribeUsagePlanRequest)
func (*DescribeUsagePlanRequest) FromJsonString ¶
func (r *DescribeUsagePlanRequest) FromJsonString(s string) error
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 DescribeUsagePlanResponse ¶
type DescribeUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeUsagePlanResponse ¶
func NewDescribeUsagePlanResponse() (response *DescribeUsagePlanResponse)
func (*DescribeUsagePlanResponse) FromJsonString ¶
func (r *DescribeUsagePlanResponse) FromJsonString(s string) error
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 DescribeUsagePlanSecretIdsRequest ¶
type DescribeUsagePlanSecretIdsRequest struct {
*tchttp.BaseRequest
// 绑定的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeUsagePlanSecretIdsRequest ¶
func NewDescribeUsagePlanSecretIdsRequest() (request *DescribeUsagePlanSecretIdsRequest)
func (*DescribeUsagePlanSecretIdsRequest) FromJsonString ¶
func (r *DescribeUsagePlanSecretIdsRequest) FromJsonString(s string) error
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 DescribeUsagePlanSecretIdsResponse ¶
type DescribeUsagePlanSecretIdsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划绑定的密钥列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlanBindSecretStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeUsagePlanSecretIdsResponse ¶
func NewDescribeUsagePlanSecretIdsResponse() (response *DescribeUsagePlanSecretIdsResponse)
func (*DescribeUsagePlanSecretIdsResponse) FromJsonString ¶
func (r *DescribeUsagePlanSecretIdsResponse) FromJsonString(s string) error
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 DescribeUsagePlansStatusRequest ¶
type DescribeUsagePlansStatusRequest struct {
*tchttp.BaseRequest
// 返回数量,默认为 20,最大值为 100。
Limit *int64 `json:"Limit,omitempty" name:"Limit"`
// 偏移量,默认为 0。
Offset *int64 `json:"Offset,omitempty" name:"Offset"`
// 使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeUsagePlansStatusRequest ¶
func NewDescribeUsagePlansStatusRequest() (request *DescribeUsagePlansStatusRequest)
func (*DescribeUsagePlansStatusRequest) FromJsonString ¶
func (r *DescribeUsagePlansStatusRequest) FromJsonString(s string) error
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 DescribeUsagePlansStatusResponse ¶
type DescribeUsagePlansStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlansStatus `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeUsagePlansStatusResponse ¶
func NewDescribeUsagePlansStatusResponse() (response *DescribeUsagePlansStatusResponse)
func (*DescribeUsagePlansStatusResponse) FromJsonString ¶
func (r *DescribeUsagePlansStatusResponse) FromJsonString(s string) error
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 DisableApiKeyRequest ¶
type DisableApiKeyRequest struct {
*tchttp.BaseRequest
// 待禁用的密钥 ID。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
}
func NewDisableApiKeyRequest ¶
func NewDisableApiKeyRequest() (request *DisableApiKeyRequest)
func (*DisableApiKeyRequest) FromJsonString ¶
func (r *DisableApiKeyRequest) FromJsonString(s string) error
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 DisableApiKeyResponse ¶
type DisableApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 禁用密钥操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDisableApiKeyResponse ¶
func NewDisableApiKeyResponse() (response *DisableApiKeyResponse)
func (*DisableApiKeyResponse) FromJsonString ¶
func (r *DisableApiKeyResponse) FromJsonString(s string) error
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 DocumentSDK ¶
type DomainSetList ¶
type DomainSetList struct {
// 域名名称。
DomainName *string `json:"DomainName,omitempty" name:"DomainName"`
// 域名解析状态。True 表示正常解析,False 表示解析失败。
Status *int64 `json:"Status,omitempty" name:"Status"`
// 证书ID。
CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"`
// 是否使用默认路径映射。
IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"`
// 自定义域名协议类型。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 网络类型('INNER' 或 'OUTER')。
NetType *string `json:"NetType,omitempty" name:"NetType"`
}
type DomainSets ¶
type DomainSets struct {
// 服务下的自定义域名数量。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 自定义服务域名列表。
DomainSet []*DomainSetList `json:"DomainSet,omitempty" name:"DomainSet" list`
}
type EnableApiKeyRequest ¶
type EnableApiKeyRequest struct {
*tchttp.BaseRequest
// 待启用的密钥 ID。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
}
func NewEnableApiKeyRequest ¶
func NewEnableApiKeyRequest() (request *EnableApiKeyRequest)
func (*EnableApiKeyRequest) FromJsonString ¶
func (r *EnableApiKeyRequest) FromJsonString(s string) error
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 EnableApiKeyResponse ¶
type EnableApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 启动密钥操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewEnableApiKeyResponse ¶
func NewEnableApiKeyResponse() (response *EnableApiKeyResponse)
func (*EnableApiKeyResponse) FromJsonString ¶
func (r *EnableApiKeyResponse) FromJsonString(s string) error
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 Environment ¶
type Environment struct {
// 环境名称。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 访问路径。
Url *string `json:"Url,omitempty" name:"Url"`
// 发布状态,1 表示已发布,0 表示未发布。
Status *uint64 `json:"Status,omitempty" name:"Status"`
// 运行版本。
VersionName *string `json:"VersionName,omitempty" name:"VersionName"`
}
type EnvironmentStrategy ¶
type ErrorCodes ¶
type ErrorCodes struct {
// 自定义响应配置错误码。
// 注意:此字段可能返回 null,表示取不到有效值。
Code *int64 `json:"Code,omitempty" name:"Code"`
// 自定义响应配置错误信息。
// 注意:此字段可能返回 null,表示取不到有效值。
Msg *string `json:"Msg,omitempty" name:"Msg"`
// 自定义响应配置错误码备注。
// 注意:此字段可能返回 null,表示取不到有效值。
Desc *string `json:"Desc,omitempty" name:"Desc"`
// 自定义错误码转换。
// 注意:此字段可能返回 null,表示取不到有效值。
ConvertedCode *int64 `json:"ConvertedCode,omitempty" name:"ConvertedCode"`
// 是否需要开启错误码转换。
// 注意:此字段可能返回 null,表示取不到有效值。
NeedConvert *bool `json:"NeedConvert,omitempty" name:"NeedConvert"`
}
type GenerateApiDocumentRequest ¶
type GenerateApiDocumentRequest struct {
*tchttp.BaseRequest
// 待创建文档的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待创建 SDK 的服务所在环境。
GenEnvironment *string `json:"GenEnvironment,omitempty" name:"GenEnvironment"`
// 待创建 SDK 的语言。当前只支持 Python 和 JavaScript。
GenLanguage *string `json:"GenLanguage,omitempty" name:"GenLanguage"`
}
func NewGenerateApiDocumentRequest ¶
func NewGenerateApiDocumentRequest() (request *GenerateApiDocumentRequest)
func (*GenerateApiDocumentRequest) FromJsonString ¶
func (r *GenerateApiDocumentRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateApiDocumentRequest) ToJsonString ¶
func (r *GenerateApiDocumentRequest) ToJsonString() string
type GenerateApiDocumentResponse ¶
type GenerateApiDocumentResponse struct {
*tchttp.BaseResponse
Response *struct {
// api文档&sdk链接。
Result *DocumentSDK `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewGenerateApiDocumentResponse ¶
func NewGenerateApiDocumentResponse() (response *GenerateApiDocumentResponse)
func (*GenerateApiDocumentResponse) FromJsonString ¶
func (r *GenerateApiDocumentResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateApiDocumentResponse) ToJsonString ¶
func (r *GenerateApiDocumentResponse) ToJsonString() string
type HealthCheckConf ¶
type HealthCheckConf struct {
// 是否开启健康检查。
IsHealthCheck *bool `json:"IsHealthCheck,omitempty" name:"IsHealthCheck"`
// 健康检查阈值。
RequestVolumeThreshold *int64 `json:"RequestVolumeThreshold,omitempty" name:"RequestVolumeThreshold"`
// 窗口大小。
SleepWindowInMilliseconds *int64 `json:"SleepWindowInMilliseconds,omitempty" name:"SleepWindowInMilliseconds"`
// 阈值百分比。
ErrorThresholdPercentage *int64 `json:"ErrorThresholdPercentage,omitempty" name:"ErrorThresholdPercentage"`
}
type IPStrategy ¶
type IPStrategy struct {
// 策略唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// 用户自定义策略名称。
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyName *string `json:"StrategyName,omitempty" name:"StrategyName"`
// 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyType *string `json:"StrategyType,omitempty" name:"StrategyType"`
// IP列表。
// 注意:此字段可能返回 null,表示取不到有效值。
StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 修改时间。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 策略绑定的API数量。
// 注意:此字段可能返回 null,表示取不到有效值。
BindApiTotalCount *int64 `json:"BindApiTotalCount,omitempty" name:"BindApiTotalCount"`
// 绑定的API详情。
// 注意:此字段可能返回 null,表示取不到有效值。
BindApis []*DesApisStatus `json:"BindApis,omitempty" name:"BindApis" list`
}
type IPStrategyApi ¶
type IPStrategyApi struct {
// API 唯一 ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 用户自定义的 API 名称。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API 类型。取值为NORMAL(普通API)和TSF (微服务API)。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API 的路径。如 /path。
Path *string `json:"Path,omitempty" name:"Path"`
// API 的请求方法。如 GET。
Method *string `json:"Method,omitempty" name:"Method"`
// API 已经绑定的其他策略唯一ID。
OtherIPStrategyId *string `json:"OtherIPStrategyId,omitempty" name:"OtherIPStrategyId"`
// API 已经绑定的环境。
OtherEnvironmentName *string `json:"OtherEnvironmentName,omitempty" name:"OtherEnvironmentName"`
}
type IPStrategyApiStatus ¶
type IPStrategyApiStatus struct {
// 环境绑定API数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 环境绑定API详情。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiIdStatusSet []*IPStrategyApi `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet" list`
}
type IPStrategysStatus ¶
type IPStrategysStatus struct {
// 策略数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 策略列表。
// 注意:此字段可能返回 null,表示取不到有效值。
StrategySet []*IPStrategy `json:"StrategySet,omitempty" name:"StrategySet" list`
}
type MicroService ¶
type MicroServiceReq ¶
type ModifyAPIDocRequest ¶
type ModifyAPIDocRequest struct {
*tchttp.BaseRequest
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
// API文档名称
ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"`
// 服务名称
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 环境名称
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 生成文档的API列表
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewModifyAPIDocRequest ¶
func NewModifyAPIDocRequest() (request *ModifyAPIDocRequest)
func (*ModifyAPIDocRequest) FromJsonString ¶
func (r *ModifyAPIDocRequest) FromJsonString(s string) error
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 ModifyAPIDocResponse ¶
type ModifyAPIDocResponse struct {
*tchttp.BaseResponse
Response *struct {
// API文档基本信息
Result *APIDoc `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyAPIDocResponse ¶
func NewModifyAPIDocResponse() (response *ModifyAPIDocResponse)
func (*ModifyAPIDocResponse) FromJsonString ¶
func (r *ModifyAPIDocResponse) FromJsonString(s string) error
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 ModifyApiEnvironmentStrategyRequest ¶
type ModifyApiEnvironmentStrategyRequest struct {
*tchttp.BaseRequest
// 服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 限流值。
Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"`
// 环境名。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// API列表。
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewModifyApiEnvironmentStrategyRequest ¶
func NewModifyApiEnvironmentStrategyRequest() (request *ModifyApiEnvironmentStrategyRequest)
func (*ModifyApiEnvironmentStrategyRequest) FromJsonString ¶
func (r *ModifyApiEnvironmentStrategyRequest) FromJsonString(s string) error
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 ModifyApiEnvironmentStrategyResponse ¶
type ModifyApiEnvironmentStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 修改操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyApiEnvironmentStrategyResponse ¶
func NewModifyApiEnvironmentStrategyResponse() (response *ModifyApiEnvironmentStrategyResponse)
func (*ModifyApiEnvironmentStrategyResponse) FromJsonString ¶
func (r *ModifyApiEnvironmentStrategyResponse) FromJsonString(s string) error
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 ModifyApiIncrementRequest ¶
type ModifyApiIncrementRequest struct {
*tchttp.BaseRequest
// 服务ID
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 接口ID
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 需要修改的API auth类型(可选择OAUTH-授权API)
BusinessType *string `json:"BusinessType,omitempty" name:"BusinessType"`
// oauth接口需要修改的公钥值
PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"`
// oauth接口重定向地址
LoginRedirectUrl *string `json:"LoginRedirectUrl,omitempty" name:"LoginRedirectUrl"`
}
func NewModifyApiIncrementRequest ¶
func NewModifyApiIncrementRequest() (request *ModifyApiIncrementRequest)
func (*ModifyApiIncrementRequest) FromJsonString ¶
func (r *ModifyApiIncrementRequest) FromJsonString(s string) error
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 ModifyApiIncrementResponse ¶
type ModifyApiIncrementResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyApiIncrementResponse ¶
func NewModifyApiIncrementResponse() (response *ModifyApiIncrementResponse)
func (*ModifyApiIncrementResponse) FromJsonString ¶
func (r *ModifyApiIncrementResponse) FromJsonString(s string) error
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 ModifyApiRequest ¶
type ModifyApiRequest struct {
*tchttp.BaseRequest
// API 所在的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"`
// 请求的前端配置。
RequestConfig *RequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"`
// API 接口唯一 ID。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// 用户自定义的 API 名称。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// 用户自定义的 API 接口描述。
ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"`
// API 类型,支持NORMAL和TSF,默认为NORMAL。
ApiType *string `json:"ApiType,omitempty" name:"ApiType"`
// API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。
AuthType *string `json:"AuthType,omitempty" name:"AuthType"`
// 是否需要签名认证,True 表示需要,False 表示不需要。待废弃。
AuthRequired *bool `json:"AuthRequired,omitempty" name:"AuthRequired"`
// API 的后端服务超时时间,单位是秒。
ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"`
// API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 是否需要开启跨域,Ture 表示需要,False 表示不需要。
EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"`
// 常量参数。
ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters" list`
// 前端请求参数。
RequestParameters []*ReqParameter `json:"RequestParameters,omitempty" name:"RequestParameters" list`
// 当AuthType 为 OAUTH时,该字段有效, NORMAL:业务api OAUTH:授权API。
ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"`
// API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"`
// API绑定微服务服务列表。
MicroServices []*MicroServiceReq `json:"MicroServices,omitempty" name:"MicroServices" list`
// 微服务的负载均衡配置。
ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"`
// 微服务的健康检查配置。
ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"`
// target类型负载均衡配置。(内测阶段)
TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitempty" name:"TargetServicesLoadBalanceConf"`
// target健康检查配置。(内测阶段)
TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitempty" name:"TargetServicesHealthCheckConf"`
// scf 函数名称。当后端类型是SCF时生效。
ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"`
// scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"`
// scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"`
// scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"`
// scf 函数命名空间。当后端类型是SCF时生效。
ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"`
// scf函数版本。当后端类型是SCF时生效。
ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"`
// scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"`
// scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"`
// scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"`
// scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"`
// scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"`
// 是否开启响应集成。当后端类型是SCF时生效。
ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"`
// 开始调试后计费。(云市场预留字段)
IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"`
// 标签。
TagSpecifications *Tag `json:"TagSpecifications,omitempty" name:"TagSpecifications"`
// 是否删除自定义响应配置错误码,如果不传或者传 False,不删除,当传 True 时,则删除此 API 所有自定义响应配置错误码。
IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitempty" name:"IsDeleteResponseErrorCodes"`
// 返回类型。
ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"`
// 自定义响应配置成功响应示例。
ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"`
// 自定义响应配置失败响应示例。
ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"`
// API 的后端服务配置。
ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"`
// 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"`
// API的后端服务参数。
ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters" list`
// oauth配置。当AuthType是OAUTH时生效。
OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"`
// 用户自定义错误码配置。
ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes" list`
// 是否开启Base64编码,只有后端为scf时才会生效。
IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"`
// 是否开启Base64编码的header触发,只有后端为scf时才会生效。
IsBase64Trigger *bool `json:"IsBase64Trigger,omitempty" name:"IsBase64Trigger"`
// Header触发规则,总规则数不能超过10。
Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitempty" name:"Base64EncodedTriggerRules" list`
}
func NewModifyApiRequest ¶
func NewModifyApiRequest() (request *ModifyApiRequest)
func (*ModifyApiRequest) FromJsonString ¶
func (r *ModifyApiRequest) FromJsonString(s string) error
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 ModifyApiResponse ¶
type ModifyApiResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyApiResponse ¶
func NewModifyApiResponse() (response *ModifyApiResponse)
func (*ModifyApiResponse) FromJsonString ¶
func (r *ModifyApiResponse) FromJsonString(s string) error
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 ModifyIPStrategyRequest ¶
type ModifyIPStrategyRequest struct {
*tchttp.BaseRequest
// 待修改的策略所属服务的唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待修改的策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// 待修改的策略详情。
StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"`
}
func NewModifyIPStrategyRequest ¶
func NewModifyIPStrategyRequest() (request *ModifyIPStrategyRequest)
func (*ModifyIPStrategyRequest) FromJsonString ¶
func (r *ModifyIPStrategyRequest) FromJsonString(s string) error
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 ModifyIPStrategyResponse ¶
type ModifyIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 修改操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyIPStrategyResponse ¶
func NewModifyIPStrategyResponse() (response *ModifyIPStrategyResponse)
func (*ModifyIPStrategyResponse) FromJsonString ¶
func (r *ModifyIPStrategyResponse) FromJsonString(s string) error
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 ModifyServiceEnvironmentStrategyRequest ¶
type ModifyServiceEnvironmentStrategyRequest struct {
*tchttp.BaseRequest
// 服务的唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 限流值。
Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"`
// 环境列表。
EnvironmentNames []*string `json:"EnvironmentNames,omitempty" name:"EnvironmentNames" list`
}
func NewModifyServiceEnvironmentStrategyRequest ¶
func NewModifyServiceEnvironmentStrategyRequest() (request *ModifyServiceEnvironmentStrategyRequest)
func (*ModifyServiceEnvironmentStrategyRequest) FromJsonString ¶
func (r *ModifyServiceEnvironmentStrategyRequest) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyServiceEnvironmentStrategyRequest) ToJsonString ¶
func (r *ModifyServiceEnvironmentStrategyRequest) ToJsonString() string
type ModifyServiceEnvironmentStrategyResponse ¶
type ModifyServiceEnvironmentStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 修改操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyServiceEnvironmentStrategyResponse ¶
func NewModifyServiceEnvironmentStrategyResponse() (response *ModifyServiceEnvironmentStrategyResponse)
func (*ModifyServiceEnvironmentStrategyResponse) FromJsonString ¶
func (r *ModifyServiceEnvironmentStrategyResponse) FromJsonString(s string) error
It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyServiceEnvironmentStrategyResponse) ToJsonString ¶
func (r *ModifyServiceEnvironmentStrategyResponse) ToJsonString() string
type ModifyServiceRequest ¶
type ModifyServiceRequest struct {
*tchttp.BaseRequest
// 待修改服务的唯一 Id。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 修改后的服务名称。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 修改后的服务描述。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// 修改后的服务前端请求类型,如 http、https和 http&https。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 网络类型列表,用于指定支持的访问类型,INNER为内网访问,OUTER为外网访问。默认为OUTER。
NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes" list`
}
func NewModifyServiceRequest ¶
func NewModifyServiceRequest() (request *ModifyServiceRequest)
func (*ModifyServiceRequest) FromJsonString ¶
func (r *ModifyServiceRequest) FromJsonString(s string) error
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 ModifyServiceResponse ¶
type ModifyServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyServiceResponse ¶
func NewModifyServiceResponse() (response *ModifyServiceResponse)
func (*ModifyServiceResponse) FromJsonString ¶
func (r *ModifyServiceResponse) FromJsonString(s string) error
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 ModifySubDomainRequest ¶
type ModifySubDomainRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待修改路径映射的自定义的域名。
SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"`
// 是否修改为使用默认路径映射。为 true,表示使用默认路径映射,为 false,表示使用自定义路径映射。
IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"`
// 证书 ID,协议包含 HTTPS 的时候要传该字段。
CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"`
// 修改后的自定义域名协议类型。(http,https 或 http&https)
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 修改后的路径映射列表。
PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet" list`
// 网络类型 ('INNER' 或 'OUTER')
NetType *string `json:"NetType,omitempty" name:"NetType"`
// 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
IsForcedHttps *bool `json:"IsForcedHttps,omitempty" name:"IsForcedHttps"`
}
func NewModifySubDomainRequest ¶
func NewModifySubDomainRequest() (request *ModifySubDomainRequest)
func (*ModifySubDomainRequest) FromJsonString ¶
func (r *ModifySubDomainRequest) FromJsonString(s string) error
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 ModifySubDomainResponse ¶
type ModifySubDomainResponse struct {
*tchttp.BaseResponse
Response *struct {
// 修改自定义域名操作是否成功。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifySubDomainResponse ¶
func NewModifySubDomainResponse() (response *ModifySubDomainResponse)
func (*ModifySubDomainResponse) FromJsonString ¶
func (r *ModifySubDomainResponse) FromJsonString(s string) error
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 ModifyUsagePlanRequest ¶
type ModifyUsagePlanRequest struct {
*tchttp.BaseRequest
// 使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 修改后的用户自定义的使用计划名称。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 修改后的用户自定义的使用计划描述。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 请求配额总数,取值范围为-1或者[1, 99999999],默认为-1,表示不开启。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 每秒请求限制数,取值范围为-1或者[1, 2000],默认-1,表示不开启。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
}
func NewModifyUsagePlanRequest ¶
func NewModifyUsagePlanRequest() (request *ModifyUsagePlanRequest)
func (*ModifyUsagePlanRequest) FromJsonString ¶
func (r *ModifyUsagePlanRequest) FromJsonString(s string) error
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 ModifyUsagePlanResponse ¶
type ModifyUsagePlanResponse struct {
*tchttp.BaseResponse
Response *struct {
// 使用计划详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyUsagePlanResponse ¶
func NewModifyUsagePlanResponse() (response *ModifyUsagePlanResponse)
func (*ModifyUsagePlanResponse) FromJsonString ¶
func (r *ModifyUsagePlanResponse) FromJsonString(s string) error
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 OauthConfig ¶
type OauthConfig struct {
// 公钥,用于验证用户token。
PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"`
// token传递位置。
TokenLocation *string `json:"TokenLocation,omitempty" name:"TokenLocation"`
// 重定向地址,用于引导用户登录操作。
LoginRedirectUrl *string `json:"LoginRedirectUrl,omitempty" name:"LoginRedirectUrl"`
}
type PathMapping ¶
type Plugin ¶
type Plugin struct {
// 插件ID。
PluginId *string `json:"PluginId,omitempty" name:"PluginId"`
// 插件名称。
PluginName *string `json:"PluginName,omitempty" name:"PluginName"`
// 插件类型。
PluginType *string `json:"PluginType,omitempty" name:"PluginType"`
// 插件定义语句。
PluginData *string `json:"PluginData,omitempty" name:"PluginData"`
// 插件描述。
// 注意:此字段可能返回 null,表示取不到有效值。
Description *string `json:"Description,omitempty" name:"Description"`
// 插件创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 插件修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 插件绑定的API总数。
// 注意:此字段可能返回 null,表示取不到有效值。
AttachedApiTotalCount *int64 `json:"AttachedApiTotalCount,omitempty" name:"AttachedApiTotalCount"`
// 插件绑定的API信息。
// 注意:此字段可能返回 null,表示取不到有效值。
AttachedApis []*AttachedApiInfo `json:"AttachedApis,omitempty" name:"AttachedApis" list`
}
type PluginSummary ¶
type ReleaseService ¶
type ReleaseServiceRequest ¶
type ReleaseServiceRequest struct {
*tchttp.BaseRequest
// 待发布服务的唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待发布的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 本次的发布描述。
ReleaseDesc *string `json:"ReleaseDesc,omitempty" name:"ReleaseDesc"`
// apiId列表,预留字段,默认全量api发布。
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewReleaseServiceRequest ¶
func NewReleaseServiceRequest() (request *ReleaseServiceRequest)
func (*ReleaseServiceRequest) FromJsonString ¶
func (r *ReleaseServiceRequest) FromJsonString(s string) error
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 ReleaseServiceResponse ¶
type ReleaseServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 发布信息。
Result *ReleaseService `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewReleaseServiceResponse ¶
func NewReleaseServiceResponse() (response *ReleaseServiceResponse)
func (*ReleaseServiceResponse) FromJsonString ¶
func (r *ReleaseServiceResponse) FromJsonString(s string) error
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 ReqParameter ¶
type ReqParameter struct {
// API 的前端参数名称。
Name *string `json:"Name,omitempty" name:"Name"`
// API 的前端参数位置,如 header。目前支持 header、query、path。
Position *string `json:"Position,omitempty" name:"Position"`
// API 的前端参数类型,如 String、int。
Type *string `json:"Type,omitempty" name:"Type"`
// API 的前端参数默认值。
DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`
// API 的前端参数是否必填,True:表示必填,False:表示可选。
Required *bool `json:"Required,omitempty" name:"Required"`
// API 的前端参数备注。
Desc *string `json:"Desc,omitempty" name:"Desc"`
}
type RequestConfig ¶
type RequestParameter ¶
type RequestParameter struct {
// 请求参数名称
Name *string `json:"Name,omitempty" name:"Name"`
// 描述
Desc *string `json:"Desc,omitempty" name:"Desc"`
// 参数位置
Position *string `json:"Position,omitempty" name:"Position"`
// 参数类型
Type *string `json:"Type,omitempty" name:"Type"`
// 默认值
DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`
// 是否必须
Required *bool `json:"Required,omitempty" name:"Required"`
}
type ResetAPIDocPasswordRequest ¶
type ResetAPIDocPasswordRequest struct {
*tchttp.BaseRequest
// API文档ID
ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"`
}
func NewResetAPIDocPasswordRequest ¶
func NewResetAPIDocPasswordRequest() (request *ResetAPIDocPasswordRequest)
func (*ResetAPIDocPasswordRequest) FromJsonString ¶
func (r *ResetAPIDocPasswordRequest) FromJsonString(s string) error
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 ResetAPIDocPasswordResponse ¶
type ResetAPIDocPasswordResponse struct {
*tchttp.BaseResponse
Response *struct {
// API文档基本信息
Result *APIDoc `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewResetAPIDocPasswordResponse ¶
func NewResetAPIDocPasswordResponse() (response *ResetAPIDocPasswordResponse)
func (*ResetAPIDocPasswordResponse) FromJsonString ¶
func (r *ResetAPIDocPasswordResponse) FromJsonString(s string) error
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 ResponseErrorCodeReq ¶
type ResponseErrorCodeReq struct {
// 自定义响应配置错误码。
Code *int64 `json:"Code,omitempty" name:"Code"`
// 自定义响应配置错误信息。
Msg *string `json:"Msg,omitempty" name:"Msg"`
// 自定义响应配置错误码备注。
Desc *string `json:"Desc,omitempty" name:"Desc"`
// 自定义错误码转换。
ConvertedCode *int64 `json:"ConvertedCode,omitempty" name:"ConvertedCode"`
// 是否需要开启错误码转换。
NeedConvert *bool `json:"NeedConvert,omitempty" name:"NeedConvert"`
}
type Service ¶
type Service struct {
// 内网访问https端口。
// 注意:此字段可能返回 null,表示取不到有效值。
InnerHttpsPort *int64 `json:"InnerHttpsPort,omitempty" name:"InnerHttpsPort"`
// 用户自定义的服务描述。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"`
// 服务的前端请求类型。如http、https 或者 http&https。
// 注意:此字段可能返回 null,表示取不到有效值。
Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 服务支持的网络类型。
// 注意:此字段可能返回 null,表示取不到有效值。
NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes" list`
// 独占集群名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"`
// 服务唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// IP版本。
// 注意:此字段可能返回 null,表示取不到有效值。
IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"`
// 已经发布的环境列表。如test、prepub、release。
// 注意:此字段可能返回 null,表示取不到有效值。
AvailableEnvironments []*string `json:"AvailableEnvironments,omitempty" name:"AvailableEnvironments" list`
// 用户自定义的服务名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
// 系统为该服务分配的外网域名。
// 注意:此字段可能返回 null,表示取不到有效值。
OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 内网访问http端口。
// 注意:此字段可能返回 null,表示取不到有效值。
InnerHttpPort *uint64 `json:"InnerHttpPort,omitempty" name:"InnerHttpPort"`
// 系统为该服务自动分配的内网域名。
// 注意:此字段可能返回 null,表示取不到有效值。
InnerSubDomain *string `json:"InnerSubDomain,omitempty" name:"InnerSubDomain"`
// 服务的计费状态。
// 注意:此字段可能返回 null,表示取不到有效值。
TradeIsolateStatus *int64 `json:"TradeIsolateStatus,omitempty" name:"TradeIsolateStatus"`
// 服务绑定的标签
// 注意:此字段可能返回 null,表示取不到有效值。
Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`
// 独享实例
// 注意:此字段可能返回 null,表示取不到有效值。
InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
// 集群类型
// 注意:此字段可能返回 null,表示取不到有效值。
SetType *string `json:"SetType,omitempty" name:"SetType"`
}
type ServiceConfig ¶
type ServiceConfig struct {
// 后端类型。启用vpc时生效,目前支持的类型为clb。
Product *string `json:"Product,omitempty" name:"Product"`
// vpc 的唯一ID。
UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"`
// API 的后端服务url。如果ServiceType是HTTP,则此参数必传。
Url *string `json:"Url,omitempty" name:"Url"`
// API 的后端服务路径,如 /path。如果 ServiceType 是 HTTP,则此参数必传。前后端路径可不同。
Path *string `json:"Path,omitempty" name:"Path"`
// API的后端服务请求方法,如 GET。如果 ServiceType 是 HTTP,则此参数必传。前后端方法可不同。
Method *string `json:"Method,omitempty" name:"Method"`
}
type ServiceEnvironmentSet ¶
type ServiceEnvironmentSet struct {
// 服务绑定环境总数。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 服务绑定环境列表。
// 注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList []*Environment `json:"EnvironmentList,omitempty" name:"EnvironmentList" list`
}
type ServiceEnvironmentStrategy ¶
type ServiceEnvironmentStrategy struct {
// 环境名。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 访问服务对应环境的url。
Url *string `json:"Url,omitempty" name:"Url"`
// 发布状态。
Status *int64 `json:"Status,omitempty" name:"Status"`
// 发布的版本号。
// 注意:此字段可能返回 null,表示取不到有效值。
VersionName *string `json:"VersionName,omitempty" name:"VersionName"`
// 限流值。
Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"`
// 最大限流值
// 注意:此字段可能返回 null,表示取不到有效值。
MaxStrategy *int64 `json:"MaxStrategy,omitempty" name:"MaxStrategy"`
}
type ServiceEnvironmentStrategyStatus ¶
type ServiceEnvironmentStrategyStatus struct {
// 限流策略数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 限流策略列表。
// 注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList []*ServiceEnvironmentStrategy `json:"EnvironmentList,omitempty" name:"EnvironmentList" list`
}
type ServiceParameter ¶
type ServiceParameter struct {
// API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
// 注意:此字段可能返回 null,表示取不到有效值。
Name *string `json:"Name,omitempty" name:"Name"`
// API 的后端服务参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
// 注意:此字段可能返回 null,表示取不到有效值。
Position *string `json:"Position,omitempty" name:"Position"`
// API 的后端服务参数对应的前端参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。
// 注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterPosition *string `json:"RelevantRequestParameterPosition,omitempty" name:"RelevantRequestParameterPosition"`
// API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
// 注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterName *string `json:"RelevantRequestParameterName,omitempty" name:"RelevantRequestParameterName"`
// API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
// 注意:此字段可能返回 null,表示取不到有效值。
DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`
// API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
// 注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterDesc *string `json:"RelevantRequestParameterDesc,omitempty" name:"RelevantRequestParameterDesc"`
// API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。
// 注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterType *string `json:"RelevantRequestParameterType,omitempty" name:"RelevantRequestParameterType"`
}
type ServiceReleaseHistory ¶
type ServiceReleaseHistory struct {
// 发布版本总数。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 历史版本列表。
// 注意:此字段可能返回 null,表示取不到有效值。
VersionList []*ServiceReleaseHistoryInfo `json:"VersionList,omitempty" name:"VersionList" list`
}
type ServiceReleaseHistoryInfo ¶
type ServiceReleaseHistoryInfo struct {
// 版本号。
// 注意:此字段可能返回 null,表示取不到有效值。
VersionName *string `json:"VersionName,omitempty" name:"VersionName"`
// 版本描述。
// 注意:此字段可能返回 null,表示取不到有效值。
VersionDesc *string `json:"VersionDesc,omitempty" name:"VersionDesc"`
// 版本发布时间。
// 注意:此字段可能返回 null,表示取不到有效值。
ReleaseTime *string `json:"ReleaseTime,omitempty" name:"ReleaseTime"`
}
type ServiceReleaseVersion ¶
type ServiceReleaseVersion struct {
// 发布版本总数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 发布版本列表。
// 注意:此字段可能返回 null,表示取不到有效值。
VersionList []*ServiceReleaseHistoryInfo `json:"VersionList,omitempty" name:"VersionList" list`
}
type ServiceSubDomainMappings ¶
type ServiceSubDomainMappings struct {
// 是否使用默认路径映射,为 True 表示使用默认路径映射;为 False 的话,表示使用自定义路径映射,此时 PathMappingSet 不为空。
IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"`
// 自定义路径映射列表。
PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet" list`
}
type ServiceUsagePlanSet ¶
type ServiceUsagePlanSet struct {
// 服务上绑定的使用计划总数。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 服务上绑定的使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceUsagePlanList []*ApiUsagePlan `json:"ServiceUsagePlanList,omitempty" name:"ServiceUsagePlanList" list`
}
type ServicesStatus ¶
type TargetServicesReq ¶
type TargetServicesReq struct {
// vm ip
VmIp *string `json:"VmIp,omitempty" name:"VmIp"`
// vpc id
VpcId *string `json:"VpcId,omitempty" name:"VpcId"`
// vm port
VmPort *int64 `json:"VmPort,omitempty" name:"VmPort"`
// cvm所在宿主机ip
HostIp *string `json:"HostIp,omitempty" name:"HostIp"`
// docker ip
DockerIp *string `json:"DockerIp,omitempty" name:"DockerIp"`
}
type TsfLoadBalanceConfResp ¶
type TsfLoadBalanceConfResp struct {
// 是否开启负载均衡。
// 注意:此字段可能返回 null,表示取不到有效值。
IsLoadBalance *bool `json:"IsLoadBalance,omitempty" name:"IsLoadBalance"`
// 负载均衡方式。
// 注意:此字段可能返回 null,表示取不到有效值。
Method *string `json:"Method,omitempty" name:"Method"`
// 是否开启会话保持。
// 注意:此字段可能返回 null,表示取不到有效值。
SessionStickRequired *bool `json:"SessionStickRequired,omitempty" name:"SessionStickRequired"`
// 会话保持超时时间。
// 注意:此字段可能返回 null,表示取不到有效值。
SessionStickTimeout *int64 `json:"SessionStickTimeout,omitempty" name:"SessionStickTimeout"`
}
type UnBindEnvironmentRequest ¶
type UnBindEnvironmentRequest struct {
*tchttp.BaseRequest
// 绑定类型,取值为 API、SERVICE,默认值为 SERVICE。
BindType *string `json:"BindType,omitempty" name:"BindType"`
// 待绑定的使用计划唯一 ID 列表。
UsagePlanIds []*string `json:"UsagePlanIds,omitempty" name:"UsagePlanIds" list`
// 待解绑的服务环境。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 待解绑的服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 唯一 ID 数组,当 BindType=API 时,需要传入此参数。
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewUnBindEnvironmentRequest ¶
func NewUnBindEnvironmentRequest() (request *UnBindEnvironmentRequest)
func (*UnBindEnvironmentRequest) FromJsonString ¶
func (r *UnBindEnvironmentRequest) FromJsonString(s string) error
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 UnBindEnvironmentResponse ¶
type UnBindEnvironmentResponse struct {
*tchttp.BaseResponse
Response *struct {
// 解绑操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUnBindEnvironmentResponse ¶
func NewUnBindEnvironmentResponse() (response *UnBindEnvironmentResponse)
func (*UnBindEnvironmentResponse) FromJsonString ¶
func (r *UnBindEnvironmentResponse) FromJsonString(s string) error
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 UnBindIPStrategyRequest ¶
type UnBindIPStrategyRequest struct {
*tchttp.BaseRequest
// 待解绑的服务唯一ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待解绑的IP策略唯一ID。
StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"`
// 待解绑的环境。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 待解绑的 API 列表。
UnBindApiIds []*string `json:"UnBindApiIds,omitempty" name:"UnBindApiIds" list`
}
func NewUnBindIPStrategyRequest ¶
func NewUnBindIPStrategyRequest() (request *UnBindIPStrategyRequest)
func (*UnBindIPStrategyRequest) FromJsonString ¶
func (r *UnBindIPStrategyRequest) FromJsonString(s string) error
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 UnBindIPStrategyResponse ¶
type UnBindIPStrategyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 解绑操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUnBindIPStrategyResponse ¶
func NewUnBindIPStrategyResponse() (response *UnBindIPStrategyResponse)
func (*UnBindIPStrategyResponse) FromJsonString ¶
func (r *UnBindIPStrategyResponse) FromJsonString(s string) error
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 UnBindSecretIdsRequest ¶
type UnBindSecretIdsRequest struct {
*tchttp.BaseRequest
// 待解绑的使用计划唯一 ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 待解绑的密钥 ID 数组。
AccessKeyIds []*string `json:"AccessKeyIds,omitempty" name:"AccessKeyIds" list`
}
func NewUnBindSecretIdsRequest ¶
func NewUnBindSecretIdsRequest() (request *UnBindSecretIdsRequest)
func (*UnBindSecretIdsRequest) FromJsonString ¶
func (r *UnBindSecretIdsRequest) FromJsonString(s string) error
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 UnBindSecretIdsResponse ¶
type UnBindSecretIdsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 解绑操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUnBindSecretIdsResponse ¶
func NewUnBindSecretIdsResponse() (response *UnBindSecretIdsResponse)
func (*UnBindSecretIdsResponse) FromJsonString ¶
func (r *UnBindSecretIdsResponse) FromJsonString(s string) error
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 UnBindSubDomainRequest ¶
type UnBindSubDomainRequest struct {
*tchttp.BaseRequest
// 服务唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待解绑的自定义的域名。
SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"`
}
func NewUnBindSubDomainRequest ¶
func NewUnBindSubDomainRequest() (request *UnBindSubDomainRequest)
func (*UnBindSubDomainRequest) FromJsonString ¶
func (r *UnBindSubDomainRequest) FromJsonString(s string) error
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 UnBindSubDomainResponse ¶
type UnBindSubDomainResponse struct {
*tchttp.BaseResponse
Response *struct {
// 解绑自定义域名操作是否成功。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUnBindSubDomainResponse ¶
func NewUnBindSubDomainResponse() (response *UnBindSubDomainResponse)
func (*UnBindSubDomainResponse) FromJsonString ¶
func (r *UnBindSubDomainResponse) FromJsonString(s string) error
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 UnReleaseServiceRequest ¶
type UnReleaseServiceRequest struct {
*tchttp.BaseRequest
// 待下线服务的唯一 ID。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待下线的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 保留字段,待下线的API列表。
ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds" list`
}
func NewUnReleaseServiceRequest ¶
func NewUnReleaseServiceRequest() (request *UnReleaseServiceRequest)
func (*UnReleaseServiceRequest) FromJsonString ¶
func (r *UnReleaseServiceRequest) FromJsonString(s string) error
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 UnReleaseServiceResponse ¶
type UnReleaseServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 下线操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUnReleaseServiceResponse ¶
func NewUnReleaseServiceResponse() (response *UnReleaseServiceResponse)
func (*UnReleaseServiceResponse) FromJsonString ¶
func (r *UnReleaseServiceResponse) FromJsonString(s string) error
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 UpdateApiKeyRequest ¶
type UpdateApiKeyRequest struct {
*tchttp.BaseRequest
// 待更换的密钥 ID。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
// 待更换的密钥 Key,更新自定义密钥时,该字段为必传。长度10 - 50字符,包括字母、数字、英文下划线。
AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"`
}
func NewUpdateApiKeyRequest ¶
func NewUpdateApiKeyRequest() (request *UpdateApiKeyRequest)
func (*UpdateApiKeyRequest) FromJsonString ¶
func (r *UpdateApiKeyRequest) FromJsonString(s string) error
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 UpdateApiKeyResponse ¶
type UpdateApiKeyResponse struct {
*tchttp.BaseResponse
Response *struct {
// 更换后的密钥详情。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *ApiKey `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUpdateApiKeyResponse ¶
func NewUpdateApiKeyResponse() (response *UpdateApiKeyResponse)
func (*UpdateApiKeyResponse) FromJsonString ¶
func (r *UpdateApiKeyResponse) FromJsonString(s string) error
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 UpdateServiceRequest ¶
type UpdateServiceRequest struct {
*tchttp.BaseRequest
// 待切换服务的唯一 Id。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// 待切换的环境名称,当前支持三个环境,test(测试环境)、prepub(预发布环境)和 release(发布环境)。
EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"`
// 切换的版本号。
VersionName *string `json:"VersionName,omitempty" name:"VersionName"`
// 本次的切换描述。
UpdateDesc *string `json:"UpdateDesc,omitempty" name:"UpdateDesc"`
}
func NewUpdateServiceRequest ¶
func NewUpdateServiceRequest() (request *UpdateServiceRequest)
func (*UpdateServiceRequest) FromJsonString ¶
func (r *UpdateServiceRequest) FromJsonString(s string) error
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 UpdateServiceResponse ¶
type UpdateServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 切换版本操作是否成功。
// 注意:此字段可能返回 null,表示取不到有效值。
Result *bool `json:"Result,omitempty" name:"Result"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewUpdateServiceResponse ¶
func NewUpdateServiceResponse() (response *UpdateServiceResponse)
func (*UpdateServiceResponse) FromJsonString ¶
func (r *UpdateServiceResponse) FromJsonString(s string) error
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 UsagePlan ¶
type UsagePlan struct {
// 环境名称。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 使用计划唯一ID。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 使用计划名称。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 使用计划描述。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 使用计划qps,-1表示没有限制。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
// 使用计划时间。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 使用计划修改时间。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
}
type UsagePlanBindSecret ¶
type UsagePlanBindSecret struct {
// 密钥ID。
// 注意:此字段可能返回 null,表示取不到有效值。
AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"`
// 密钥名称。
// 注意:此字段可能返回 null,表示取不到有效值。
SecretName *string `json:"SecretName,omitempty" name:"SecretName"`
// 密钥状态,0表示已禁用,1表示启用中。
// 注意:此字段可能返回 null,表示取不到有效值。
Status *int64 `json:"Status,omitempty" name:"Status"`
}
type UsagePlanBindSecretStatus ¶
type UsagePlanBindSecretStatus struct {
// 使用计划绑定密钥的数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 密钥详情列表。
// 注意:此字段可能返回 null,表示取不到有效值。
AccessKeyList []*UsagePlanBindSecret `json:"AccessKeyList,omitempty" name:"AccessKeyList" list`
}
type UsagePlanEnvironment ¶
type UsagePlanEnvironment struct {
// 绑定的服务唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"`
// API 的唯一ID。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiId *string `json:"ApiId,omitempty" name:"ApiId"`
// API 的名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ApiName *string `json:"ApiName,omitempty" name:"ApiName"`
// API 的路径。
// 注意:此字段可能返回 null,表示取不到有效值。
Path *string `json:"Path,omitempty" name:"Path"`
// API 的方法。
// 注意:此字段可能返回 null,表示取不到有效值。
Method *string `json:"Method,omitempty" name:"Method"`
// 已经绑定的环境名称。
// 注意:此字段可能返回 null,表示取不到有效值。
Environment *string `json:"Environment,omitempty" name:"Environment"`
// 已经使用的配额。
// 注意:此字段可能返回 null,表示取不到有效值。
InUseRequestNum *int64 `json:"InUseRequestNum,omitempty" name:"InUseRequestNum"`
// 最大请求量。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 每秒最大请求次数。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 服务名称。
// 注意:此字段可能返回 null,表示取不到有效值。
ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"`
}
type UsagePlanEnvironmentStatus ¶
type UsagePlanEnvironmentStatus struct {
// 使用计划绑定的服务的环境数。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 使用计划已经绑定的各个服务的环境状态。
// 注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList []*UsagePlanEnvironment `json:"EnvironmentList,omitempty" name:"EnvironmentList" list`
}
type UsagePlanInfo ¶
type UsagePlanInfo struct {
// 使用计划唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 使用计划名称。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 使用计划描述。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 初始化调用次数。
// 注意:此字段可能返回 null,表示取不到有效值。
InitQuota *int64 `json:"InitQuota,omitempty" name:"InitQuota"`
// 每秒请求限制数。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
// 最大调用次数。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 是否隐藏。
// 注意:此字段可能返回 null,表示取不到有效值。
IsHide *int64 `json:"IsHide,omitempty" name:"IsHide"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
// 绑定密钥的数量。
// 注意:此字段可能返回 null,表示取不到有效值。
BindSecretIdTotalCount *int64 `json:"BindSecretIdTotalCount,omitempty" name:"BindSecretIdTotalCount"`
// 绑定密钥的详情。
// 注意:此字段可能返回 null,表示取不到有效值。
BindSecretIds []*string `json:"BindSecretIds,omitempty" name:"BindSecretIds" list`
// 绑定环境数量。
// 注意:此字段可能返回 null,表示取不到有效值。
BindEnvironmentTotalCount *int64 `json:"BindEnvironmentTotalCount,omitempty" name:"BindEnvironmentTotalCount"`
// 绑定环境详情。
// 注意:此字段可能返回 null,表示取不到有效值。
BindEnvironments []*UsagePlanBindEnvironment `json:"BindEnvironments,omitempty" name:"BindEnvironments" list`
}
type UsagePlanStatusInfo ¶
type UsagePlanStatusInfo struct {
// 使用计划唯一 ID。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"`
// 用户自定义的使用计划名称。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"`
// 用户自定义的使用计划描述。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"`
// 每秒最大请求次数。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"`
// 请求配额总量,-1表示没有限制。
// 注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"`
// 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"`
// 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
// 注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"`
}
type UsagePlansStatus ¶
type UsagePlansStatus struct {
// 符合条件的使用计划数量。
// 注意:此字段可能返回 null,表示取不到有效值。
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 使用计划列表。
// 注意:此字段可能返回 null,表示取不到有效值。
UsagePlanStatusSet []*UsagePlanStatusInfo `json:"UsagePlanStatusSet,omitempty" name:"UsagePlanStatusSet" list`
}