Documentation ¶
Index ¶
- Constants
- type APIDoc
- type APIDocInfo
- type APIDocs
- type ApiAppApiInfo
- type ApiAppApiInfos
- type ApiAppInfo
- type ApiAppInfos
- type ApiEnvironmentStrategy
- type ApiEnvironmentStrategyStataus
- type ApiIdStatus
- type ApiInfo
- type ApiInfoSummary
- type ApiKey
- type ApiKeysStatus
- type ApiRequestConfig
- type ApiUsagePlan
- type ApiUsagePlanSet
- type ApisStatus
- type AttachPluginRequest
- type AttachPluginResponse
- type AttachedApiInfo
- type AttachedApiSummary
- type AvailableApiInfo
- type Base64EncodedTriggerRule
- type BindApiAppRequest
- type BindApiAppResponse
- 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) AttachPlugin(request *AttachPluginRequest) (response *AttachPluginResponse, err error)
- func (c *Client) AttachPluginWithContext(ctx context.Context, request *AttachPluginRequest) (response *AttachPluginResponse, err error)
- func (c *Client) BindApiApp(request *BindApiAppRequest) (response *BindApiAppResponse, err error)
- func (c *Client) BindApiAppWithContext(ctx context.Context, request *BindApiAppRequest) (response *BindApiAppResponse, err error)
- func (c *Client) BindEnvironment(request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
- func (c *Client) BindEnvironmentWithContext(ctx context.Context, request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
- func (c *Client) BindIPStrategy(request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
- func (c *Client) BindIPStrategyWithContext(ctx context.Context, request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
- func (c *Client) BindSecretIds(request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
- func (c *Client) BindSecretIdsWithContext(ctx context.Context, request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
- func (c *Client) BindSubDomain(request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
- func (c *Client) BindSubDomainWithContext(ctx context.Context, request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
- func (c *Client) BuildAPIDoc(request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
- func (c *Client) BuildAPIDocWithContext(ctx context.Context, request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
- func (c *Client) CreateAPIDoc(request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
- func (c *Client) CreateAPIDocWithContext(ctx context.Context, request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
- func (c *Client) CreateApi(request *CreateApiRequest) (response *CreateApiResponse, err error)
- func (c *Client) CreateApiApp(request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)
- func (c *Client) CreateApiAppWithContext(ctx context.Context, request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)
- func (c *Client) CreateApiKey(request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
- func (c *Client) CreateApiKeyWithContext(ctx context.Context, request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
- func (c *Client) CreateApiWithContext(ctx context.Context, request *CreateApiRequest) (response *CreateApiResponse, err error)
- func (c *Client) CreateIPStrategy(request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
- func (c *Client) CreateIPStrategyWithContext(ctx context.Context, request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
- func (c *Client) CreatePlugin(request *CreatePluginRequest) (response *CreatePluginResponse, err error)
- func (c *Client) CreatePluginWithContext(ctx context.Context, request *CreatePluginRequest) (response *CreatePluginResponse, err error)
- func (c *Client) CreateService(request *CreateServiceRequest) (response *CreateServiceResponse, err error)
- func (c *Client) CreateServiceWithContext(ctx context.Context, request *CreateServiceRequest) (response *CreateServiceResponse, err error)
- func (c *Client) CreateUsagePlan(request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
- func (c *Client) CreateUsagePlanWithContext(ctx context.Context, request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
- func (c *Client) DeleteAPIDoc(request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
- func (c *Client) DeleteAPIDocWithContext(ctx context.Context, request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
- func (c *Client) DeleteApi(request *DeleteApiRequest) (response *DeleteApiResponse, err error)
- func (c *Client) DeleteApiApp(request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)
- func (c *Client) DeleteApiAppWithContext(ctx context.Context, request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)
- func (c *Client) DeleteApiKey(request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
- func (c *Client) DeleteApiKeyWithContext(ctx context.Context, request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
- func (c *Client) DeleteApiWithContext(ctx context.Context, request *DeleteApiRequest) (response *DeleteApiResponse, err error)
- func (c *Client) DeleteIPStrategy(request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
- func (c *Client) DeleteIPStrategyWithContext(ctx context.Context, request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
- func (c *Client) DeletePlugin(request *DeletePluginRequest) (response *DeletePluginResponse, err error)
- func (c *Client) DeletePluginWithContext(ctx context.Context, request *DeletePluginRequest) (response *DeletePluginResponse, 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) DeleteServiceSubDomainMappingWithContext(ctx context.Context, request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)
- func (c *Client) DeleteServiceWithContext(ctx context.Context, request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)
- func (c *Client) DeleteUsagePlan(request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
- func (c *Client) DeleteUsagePlanWithContext(ctx context.Context, request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
- func (c *Client) DemoteServiceUsagePlan(request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
- func (c *Client) DemoteServiceUsagePlanWithContext(ctx context.Context, request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
- func (c *Client) DescribeAPIDocDetail(request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
- func (c *Client) DescribeAPIDocDetailWithContext(ctx context.Context, request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
- func (c *Client) DescribeAPIDocs(request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
- func (c *Client) DescribeAPIDocsWithContext(ctx context.Context, request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
- func (c *Client) DescribeAllPluginApis(request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)
- func (c *Client) DescribeAllPluginApisWithContext(ctx context.Context, request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)
- func (c *Client) DescribeApi(request *DescribeApiRequest) (response *DescribeApiResponse, err error)
- func (c *Client) DescribeApiApp(request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)
- func (c *Client) DescribeApiAppBindApisStatus(request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)
- func (c *Client) DescribeApiAppBindApisStatusWithContext(ctx context.Context, request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)
- func (c *Client) DescribeApiAppWithContext(ctx context.Context, request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)
- func (c *Client) DescribeApiAppsStatus(request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)
- func (c *Client) DescribeApiAppsStatusWithContext(ctx context.Context, request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)
- func (c *Client) DescribeApiBindApiAppsStatus(request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)
- func (c *Client) DescribeApiBindApiAppsStatusWithContext(ctx context.Context, request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)
- func (c *Client) DescribeApiEnvironmentStrategy(request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeApiEnvironmentStrategyWithContext(ctx context.Context, request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeApiForApiApp(request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)
- func (c *Client) DescribeApiForApiAppWithContext(ctx context.Context, request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)
- func (c *Client) DescribeApiKey(request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
- func (c *Client) DescribeApiKeyWithContext(ctx context.Context, request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
- func (c *Client) DescribeApiKeysStatus(request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
- func (c *Client) DescribeApiKeysStatusWithContext(ctx context.Context, request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
- func (c *Client) DescribeApiUsagePlan(request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
- func (c *Client) DescribeApiUsagePlanWithContext(ctx context.Context, request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
- func (c *Client) DescribeApiWithContext(ctx context.Context, request *DescribeApiRequest) (response *DescribeApiResponse, err error)
- func (c *Client) DescribeApisStatus(request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)
- func (c *Client) DescribeApisStatusWithContext(ctx context.Context, 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) DescribeIPStrategyApisStatusWithContext(ctx context.Context, request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)
- func (c *Client) DescribeIPStrategyWithContext(ctx context.Context, request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)
- func (c *Client) DescribeIPStrategysStatus(request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
- func (c *Client) DescribeIPStrategysStatusWithContext(ctx context.Context, request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
- func (c *Client) DescribeLogSearch(request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
- func (c *Client) DescribeLogSearchWithContext(ctx context.Context, request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
- func (c *Client) DescribePlugin(request *DescribePluginRequest) (response *DescribePluginResponse, err error)
- func (c *Client) DescribePluginApis(request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)
- func (c *Client) DescribePluginApisWithContext(ctx context.Context, request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)
- func (c *Client) DescribePluginWithContext(ctx context.Context, request *DescribePluginRequest) (response *DescribePluginResponse, 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) DescribeServiceEnvironmentListWithContext(ctx context.Context, request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)
- func (c *Client) DescribeServiceEnvironmentReleaseHistory(request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
- func (c *Client) DescribeServiceEnvironmentReleaseHistoryWithContext(ctx context.Context, request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
- func (c *Client) DescribeServiceEnvironmentStrategy(request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeServiceEnvironmentStrategyWithContext(ctx context.Context, request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
- func (c *Client) DescribeServiceForApiApp(request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)
- func (c *Client) DescribeServiceForApiAppWithContext(ctx context.Context, request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)
- func (c *Client) DescribeServiceReleaseVersion(request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
- func (c *Client) DescribeServiceReleaseVersionWithContext(ctx context.Context, request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
- func (c *Client) DescribeServiceSubDomainMappings(request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
- func (c *Client) DescribeServiceSubDomainMappingsWithContext(ctx context.Context, request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
- func (c *Client) DescribeServiceSubDomains(request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
- func (c *Client) DescribeServiceSubDomainsWithContext(ctx context.Context, request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
- func (c *Client) DescribeServiceUsagePlan(request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
- func (c *Client) DescribeServiceUsagePlanWithContext(ctx context.Context, request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
- func (c *Client) DescribeServiceWithContext(ctx context.Context, request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)
- func (c *Client) DescribeServicesStatus(request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)
- func (c *Client) DescribeServicesStatusWithContext(ctx context.Context, 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) DescribeUsagePlanEnvironmentsWithContext(ctx context.Context, request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)
- func (c *Client) DescribeUsagePlanSecretIds(request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
- func (c *Client) DescribeUsagePlanSecretIdsWithContext(ctx context.Context, request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
- func (c *Client) DescribeUsagePlanWithContext(ctx context.Context, request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)
- func (c *Client) DescribeUsagePlansStatus(request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
- func (c *Client) DescribeUsagePlansStatusWithContext(ctx context.Context, request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
- func (c *Client) DetachPlugin(request *DetachPluginRequest) (response *DetachPluginResponse, err error)
- func (c *Client) DetachPluginWithContext(ctx context.Context, request *DetachPluginRequest) (response *DetachPluginResponse, err error)
- func (c *Client) DisableApiKey(request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
- func (c *Client) DisableApiKeyWithContext(ctx context.Context, request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
- func (c *Client) EnableApiKey(request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
- func (c *Client) EnableApiKeyWithContext(ctx context.Context, request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
- func (c *Client) GenerateApiDocument(request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
- func (c *Client) GenerateApiDocumentWithContext(ctx context.Context, request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
- func (c *Client) ModifyAPIDoc(request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
- func (c *Client) ModifyAPIDocWithContext(ctx context.Context, request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
- func (c *Client) ModifyApi(request *ModifyApiRequest) (response *ModifyApiResponse, err error)
- func (c *Client) ModifyApiApp(request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)
- func (c *Client) ModifyApiAppWithContext(ctx context.Context, request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)
- func (c *Client) ModifyApiEnvironmentStrategy(request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
- func (c *Client) ModifyApiEnvironmentStrategyWithContext(ctx context.Context, request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
- func (c *Client) ModifyApiIncrement(request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
- func (c *Client) ModifyApiIncrementWithContext(ctx context.Context, request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
- func (c *Client) ModifyApiWithContext(ctx context.Context, request *ModifyApiRequest) (response *ModifyApiResponse, err error)
- func (c *Client) ModifyIPStrategy(request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
- func (c *Client) ModifyIPStrategyWithContext(ctx context.Context, request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
- func (c *Client) ModifyPlugin(request *ModifyPluginRequest) (response *ModifyPluginResponse, err error)
- func (c *Client) ModifyPluginWithContext(ctx context.Context, request *ModifyPluginRequest) (response *ModifyPluginResponse, 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) ModifyServiceEnvironmentStrategyWithContext(ctx context.Context, request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)
- func (c *Client) ModifyServiceWithContext(ctx context.Context, request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)
- func (c *Client) ModifySubDomain(request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
- func (c *Client) ModifySubDomainWithContext(ctx context.Context, request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
- func (c *Client) ModifyUsagePlan(request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
- func (c *Client) ModifyUsagePlanWithContext(ctx context.Context, request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
- func (c *Client) ReleaseService(request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
- func (c *Client) ReleaseServiceWithContext(ctx context.Context, request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
- func (c *Client) ResetAPIDocPassword(request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
- func (c *Client) ResetAPIDocPasswordWithContext(ctx context.Context, request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
- func (c *Client) UnBindEnvironment(request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
- func (c *Client) UnBindEnvironmentWithContext(ctx context.Context, request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
- func (c *Client) UnBindIPStrategy(request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
- func (c *Client) UnBindIPStrategyWithContext(ctx context.Context, request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
- func (c *Client) UnBindSecretIds(request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
- func (c *Client) UnBindSecretIdsWithContext(ctx context.Context, request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
- func (c *Client) UnBindSubDomain(request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
- func (c *Client) UnBindSubDomainWithContext(ctx context.Context, request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
- func (c *Client) UnReleaseService(request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
- func (c *Client) UnReleaseServiceWithContext(ctx context.Context, request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
- func (c *Client) UnbindApiApp(request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)
- func (c *Client) UnbindApiAppWithContext(ctx context.Context, request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)
- func (c *Client) UpdateApiAppKey(request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)
- func (c *Client) UpdateApiAppKeyWithContext(ctx context.Context, request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)
- func (c *Client) UpdateApiKey(request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
- func (c *Client) UpdateApiKeyWithContext(ctx context.Context, request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
- func (c *Client) UpdateService(request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
- func (c *Client) UpdateServiceWithContext(ctx context.Context, request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
- type ConstantParameter
- type CreateAPIDocRequest
- type CreateAPIDocResponse
- type CreateApiAppRequest
- type CreateApiAppResponse
- type CreateApiKeyRequest
- type CreateApiKeyResponse
- type CreateApiRequest
- type CreateApiResponse
- type CreateApiRsp
- type CreateIPStrategyRequest
- type CreateIPStrategyResponse
- type CreatePluginRequest
- type CreatePluginResponse
- type CreateServiceRequest
- type CreateServiceResponse
- type CreateUsagePlanRequest
- type CreateUsagePlanResponse
- type DeleteAPIDocRequest
- type DeleteAPIDocResponse
- type DeleteApiAppRequest
- type DeleteApiAppResponse
- type DeleteApiKeyRequest
- type DeleteApiKeyResponse
- type DeleteApiRequest
- type DeleteApiResponse
- type DeleteIPStrategyRequest
- type DeleteIPStrategyResponse
- type DeletePluginRequest
- type DeletePluginResponse
- 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 DescribeAllPluginApisRequest
- type DescribeAllPluginApisResponse
- type DescribeApiAppBindApisStatusRequest
- type DescribeApiAppBindApisStatusResponse
- type DescribeApiAppRequest
- type DescribeApiAppResponse
- type DescribeApiAppsStatusRequest
- type DescribeApiAppsStatusResponse
- type DescribeApiBindApiAppsStatusRequest
- type DescribeApiBindApiAppsStatusResponse
- type DescribeApiEnvironmentStrategyRequest
- type DescribeApiEnvironmentStrategyResponse
- type DescribeApiForApiAppRequest
- type DescribeApiForApiAppResponse
- 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 DescribePluginApisRequest
- type DescribePluginApisResponse
- type DescribePluginRequest
- type DescribePluginResponse
- type DescribeServiceEnvironmentListRequest
- type DescribeServiceEnvironmentListResponse
- type DescribeServiceEnvironmentReleaseHistoryRequest
- type DescribeServiceEnvironmentReleaseHistoryResponse
- type DescribeServiceEnvironmentStrategyRequest
- type DescribeServiceEnvironmentStrategyResponse
- type DescribeServiceForApiAppRequest
- type DescribeServiceForApiAppResponse
- 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 DetachPluginRequest
- type DetachPluginResponse
- 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 ModifyApiAppRequest
- type ModifyApiAppResponse
- type ModifyApiEnvironmentStrategyRequest
- type ModifyApiEnvironmentStrategyResponse
- type ModifyApiIncrementRequest
- type ModifyApiIncrementResponse
- type ModifyApiRequest
- type ModifyApiResponse
- type ModifyIPStrategyRequest
- type ModifyIPStrategyResponse
- type ModifyPluginRequest
- type ModifyPluginResponse
- type ModifyServiceEnvironmentStrategyRequest
- type ModifyServiceEnvironmentStrategyResponse
- type ModifyServiceRequest
- type ModifyServiceResponse
- type ModifySubDomainRequest
- type ModifySubDomainResponse
- type ModifyUsagePlanRequest
- type ModifyUsagePlanResponse
- type OauthConfig
- type PathMapping
- type Plugin
- 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 UnbindApiAppRequest
- type UnbindApiAppResponse
- type UpdateApiAppKeyRequest
- type UpdateApiAppKeyResponse
- 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 ( // Error with CAM signature/authentication. AUTHFAILURE = "AuthFailure" // `DryRun` Operation. It means that the request would have succeeded, but the `DryRun` parameter was used. DRYRUNOPERATION = "DryRunOperation" // Operation failed. FAILEDOPERATION = "FailedOperation" // The custom key already exists. FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" // This API has been bound with a usage plan. FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen" // The APIs have already been bound to a usage plan. Please unbind them and try again. FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment" // API error. FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" // The API is being manipulated. Please try again later. FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" // An error occurred while binding a certificate. FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError" // The certificate is an enterprise certificate and waiting to be submitted. FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit" // The certificate does not exist or you do not have permission to view it. Please upload a valid certificate in the SSL Certificates Service Console. FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError" // The certificate has expired. Please upload a valid one. FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired" // The certificate information is empty. Please submit a ticket for assistance. FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError" // The certificate is under review. Please upload a valid one. FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify" // The certificate is in an unknown status. Please submit a ticket to check its specific status. FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError" // The certificate has been rejected. Please upload a valid one. FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail" // The Apis certificate is empty. Please upload a certificate. FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull" // API document operation failed. FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" // The Apis environment configuration is incorrect. FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError" // The Apis custom path mapping cannot be empty. FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull" // The Apis parameters are repeated. FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat" // The Apis custom path configuration is incorrect. FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError" // An error occurred while deleting the custom domain name. FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError" // The custom domain name of the service is incorrect. FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError" // The domain name has been bound to another service. FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService" // The domain name has already been bound to this service. FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService" // Unable to connect: the current domain name is not compliant. FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList" // The domain name does not have an ICP filing through Tencent Cloud. Please get the ICP filing before binding the domain name. FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian" // Failed to unbind the custom domain name, as the domain name is not bound to the service. FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService" // The domain name is not configured with a CNAME record resolving to the default domain name, or the resolution has not taken effect yet. FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError" // Failed to bind/unbind EventBridge. FAILEDOPERATION_EBERROR = "FailedOperation.EbError" // The domain name format is incorrect. FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" // Failed to generate the API documentation. FAILEDOPERATION_GENERATEAPIDOCUMENTERROR = "FailedOperation.GenerateApiDocumentError" // Failed to get the role. Please make sure that relevant API Gateway service APIs have been authorized. FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" // The instance does not exist or is invalid. FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist" // The Apis custom path conflicts with the default path. FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping" // The entered default second-level domain name is incorrect. FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError" // An error occurred while setting the path mapping. FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError" // Failed to bind/unbind SCF trigger. FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError" // Service error. FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" // The service is in use. Please try again later. FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" // The service does not exist. FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" // The custom domain name already uses the default path mapping, so no custom path can be set. FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError" // The custom domain name format is incorrect. FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" // The tag was not bound to the specified service. FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError" // The protocol type is incorrect. FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError" // Internal error. INTERNALERROR = "InternalError" // API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket. INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" // CAuth internal request error. Please try again later. If the problem persists, please submit a ticket. INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException" // OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" // SCF internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" // TSF internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException" // VPC internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" // Incorrect parameter. INVALIDPARAMETER = "InvalidParameter" // Incorrect parameter format. INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" // The parameter value is incorrect. INVALIDPARAMETERVALUE = "InvalidParameterValue" // Duplicate plugin parameter values. Please modify and try again. INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig" // Invalid backend IP address. INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp" // Incorrect key. INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds" // The API business type passed in must be `OAUTH`. INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" // Incorrect API ID INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds" // Invalid API configuration. INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" // The API type is incorrect. The microservice API only supports the TSF backend service type. INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType" // The backend service path configuration is incorrect. INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" // Invalid CLB configuration. INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" // Policy error. INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition" // The constant parameter is invalid. INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters" // The value of the `Env` parameter is incorrect. Its valid values are (release, prepub, test). INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv" // Invalid service environment status INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus" // The parameter value is incorrect. INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" // The `GenLanguage` parameter value is incorrect. INVALIDPARAMETERVALUE_INVALIDGENLANGUAGE = "InvalidParameterValue.InvalidGenLanguage" // The value of the backend address parameter is incorrect. INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" // The method is incorrect. For backend services in the WEBSOCKET type, the frontend method should be configured as GET. INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod" // Plugin parameter value error. Please modify and try again. INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig" // The backend service port is incorrect. INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" // Invalid protocol type parameter. INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol" // The OAUTH 2.0 API public key parameter is in an incorrect format. INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey" // Incorrect region. INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" // Invalid request parameter. INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" // The SCF API parameters are invalid. INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" // Invalid service configuration. INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" // The `ServiceMockReturnMessage` parameter is incorrect. INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage" // The parameter configuration is incorrect, as the parameter is not configured in the backend parameter configuration list. INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" // The `ServiceParameters` parameter is incorrect. INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters" // The backend service type is incorrect. For backend services in WEBSOCKET type, the frontend protocol should be configured as WEBSOCKET. INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" // Incorrect tag parameters INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues" // Incorrect configuration of the TSF-type API. INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig" // The backend channel does not exist or is invalid. INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream" // The URL parameters are invalid. INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" // The method is incorrect. For backend services in the WEBSOCKET type, the frontend method should be configured as GET. INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod" // The length of the parameter exceeds the limit. INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" // The number of parameters has reached the limit (100). INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" // The parameter value is incorrect, as it is not an available option. INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" // There are no modifiable items for the OAuth API. INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth" // The backend parameter configuration is incorrect, as the related frontend parameters are not configured. INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch" // The number of parameters exceeded limit. INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded" // The parameter value is incorrect, as it is not within the valid value range. INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" // The quota limit is exceeded. LIMITEXCEEDED = "LimitExceeded" // The number of API documents exceeds the limit. LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded" // Number of applications bound with the service reaches the upper limit. LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded" // The number of APIs exceeds the limit. LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded" // The number of keys exceeds the limit. LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded" // You can set up to 3 sets of custom path mappings. LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit" // The number of bound domain names exceeds the limit. You can bind up to 5 domain names by default. LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit" // The number of IP policies exceeds the limit. LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded" // The request frequency has reached the limit. Please try again later. LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" // Too many services are bound to the plugin. Unbind some services or increase the quota, and try again. LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded" // The number of services exceeds the limit. Please delete some services or increase the limit and try again. LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded" // The number of usage plans exceeds the limit. LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded" // Missing parameter. MISSINGPARAMETER = "MissingParameter" // The backend service parameter is missing. MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam" // Parameter is missing in the plugin. Please check and try again. MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig" // Operation denied. OPERATIONDENIED = "OperationDenied" // The number of requests exceeds the frequency limit. REQUESTLIMITEXCEEDED = "RequestLimitExceeded" // The resource is in use. RESOURCEINUSE = "ResourceInUse" // Insufficient resource. RESOURCEINSUFFICIENT = "ResourceInsufficient" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // The key does not exist. RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" // Incorrect `ApiId`. RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" // The application ID is incorrect. RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" // The API document does not exist. RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" // The IP policy does not exist. RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy" // Error with the OAuth service API. RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi" // The plugin does not exist. RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" // The corresponding service is invisible. RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" // The usage plan does not exist. RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" // The resource is unavailable. RESOURCEUNAVAILABLE = "ResourceUnavailable" // The resources have been sold out. RESOURCESSOLDOUT = "ResourcesSoldOut" // The operation is unauthorized. UNAUTHORIZEDOPERATION = "UnauthorizedOperation" // You do not have permission to access the resource. UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource" // The user has not passed identity verification. UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser" // Unknown parameter. UNKNOWNPARAMETER = "UnknownParameter" // Unsupported operation. UNSUPPORTEDOPERATION = "UnsupportedOperation" // The key has already been bound to a usage plan. UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan" // The current plugin cannot be bound. UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin" // Cannot force HTTPS when the protocol is HTTP. UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps" // API error. UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" // Backend type not supported UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType" // The service is currently isolated and therefore the operation is not supported. UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" // The current key status does not support this operation. UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus" // The EIAM authentication API cannot be modified. UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi" // The network type cannot be modified UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType" // The frontend protocol type cannot be changed. UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol" // The current usage plan is not bound to an environment. UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv" // Network types cannot be reduced. UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes" // The resource has been associated. Please disassociate it first. UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" // The key has already been bound to a usage plan. Please unbind it and try again. UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse" // The resource is not associated. UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated" // The current `Uin` is not in the manual key allowlist. UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList" // The key has already been bound to a usage plan. UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey" // The environment cannot be bound. UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment" // The current API has already been bound to a business API. Please unbind it and try again. UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi" // This service is being used and cannot be deleted. UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService" // Unsupported network type UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType" // The environment cannot be unbound, as there are APIs that are not bound to a usage plan. UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment" // The current key status does not support this operation. UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey" // The current plan is in use. Please unbind it and try again. UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse" )
const APIVersion = "2018-08-08"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIDocInfo ¶
type APIDocInfo struct { // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` // API document name ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"` // API document build status ApiDocStatus *string `json:"ApiDocStatus,omitempty" name:"ApiDocStatus"` // Number of APIs with API documents ApiCount *int64 `json:"ApiCount,omitempty" name:"ApiCount"` // Number of views of API document ViewCount *int64 `json:"ViewCount,omitempty" name:"ViewCount"` // Number of releases of API document ReleaseCount *int64 `json:"ReleaseCount,omitempty" name:"ReleaseCount"` // API document access URI ApiDocUri *string `json:"ApiDocUri,omitempty" name:"ApiDocUri"` SharePassword *string `json:"SharePassword,omitempty" name:"SharePassword"` // API document update time UpdatedTime *string `json:"UpdatedTime,omitempty" name:"UpdatedTime"` // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment information Environment *string `json:"Environment,omitempty" name:"Environment"` // ID of the API for which to generate the API document ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` // Service name ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Name of the API for which to generate the API document ApiNames []*string `json:"ApiNames,omitempty" name:"ApiNames"` }
type ApiAppApiInfo ¶
type ApiAppApiInfo struct { // Application name // Note: this field may return null, indicating that no valid values can be obtained. ApiAppName *string `json:"ApiAppName,omitempty" name:"ApiAppName"` // Application ID ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // API ID // Note: this field may return null, indicating that no valid values can be obtained. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API name // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // Service ID // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Binding authorization time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. AuthorizedTime *string `json:"AuthorizedTime,omitempty" name:"AuthorizedTime"` // API region // Note: this field may return null, indicating that no valid values can be obtained. ApiRegion *string `json:"ApiRegion,omitempty" name:"ApiRegion"` // Authorized binding environment // Note: this field may return null, indicating that no valid values can be obtained. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` }
type ApiAppApiInfos ¶
type ApiAppApiInfos struct { // Quantity TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Information array of the API bound to the application // Note: this field may return null, indicating that no valid values can be obtained. ApiAppApiSet []*ApiAppApiInfo `json:"ApiAppApiSet,omitempty" name:"ApiAppApiSet"` }
type ApiAppInfo ¶
type ApiAppInfo struct { // Application name // Note: this field may return null, indicating that no valid values can be obtained. ApiAppName *string `json:"ApiAppName,omitempty" name:"ApiAppName"` // Application ID ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Application SECRET // Note: this field may return null, indicating that no valid values can be obtained. ApiAppSecret *string `json:"ApiAppSecret,omitempty" name:"ApiAppSecret"` // Application description // Note: this field may return null, indicating that no valid values can be obtained. ApiAppDesc *string `json:"ApiAppDesc,omitempty" name:"ApiAppDesc"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Application KEY // Note: this field may return null, indicating that no valid values can be obtained. ApiAppKey *string `json:"ApiAppKey,omitempty" name:"ApiAppKey"` }
type ApiAppInfos ¶
type ApiAppInfos struct { // Number of applications TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Application information array // Note: this field may return null, indicating that no valid values can be obtained. ApiAppSet []*ApiAppInfo `json:"ApiAppSet,omitempty" name:"ApiAppSet"` }
type ApiEnvironmentStrategy ¶
type ApiEnvironmentStrategy struct { // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Custom API name. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API path, such as `/path`. Path *string `json:"Path,omitempty" name:"Path"` // API method, such as `GET`. Method *string `json:"Method,omitempty" name:"Method"` // Environment throttling information. EnvironmentStrategySet []*EnvironmentStrategy `json:"EnvironmentStrategySet,omitempty" name:"EnvironmentStrategySet"` }
type ApiEnvironmentStrategyStataus ¶
type ApiEnvironmentStrategyStataus struct { // Number of throttling policies bound to API. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of throttling policies bound to API. // Note: this field may return null, indicating that no valid values can be obtained. ApiEnvironmentStrategySet []*ApiEnvironmentStrategy `json:"ApiEnvironmentStrategySet,omitempty" name:"ApiEnvironmentStrategySet"` }
type ApiIdStatus ¶
type ApiIdStatus struct { // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API description 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"` // Service creation time. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Service modification time. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // API name. // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // Unique VPC ID. // Note: this field may return null, indicating that no valid values can be obtained. UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"` // API type. // Note: this field may return null, indicating that no valid values can be obtained. ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API protocol. // Note: this field may return null, indicating that no valid values can be obtained. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Whether to enable debugging after purchase. // Note: this field may return null, indicating that no valid values can be obtained. IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"` // Authorization type. // Note: this field may return null, indicating that no valid values can be obtained. AuthType *string `json:"AuthType,omitempty" name:"AuthType"` // API business type. // Note: this field may return null, indicating that no valid values can be obtained. ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"` // Unique ID of associated authorization API. // Note: this field may return null, indicating that no valid values can be obtained. AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"` // List of business APIs associated with authorization API. // Note: this field may return null, indicating that no valid values can be obtained. RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitempty" name:"RelationBuniessApiIds"` // OAuth configuration information. // Note: this field may return null, indicating that no valid values can be obtained. OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"` // Token storage position, which is an OAuth 2.0 API request. // Note: this field may return null, indicating that no valid values can be obtained. TokenLocation *string `json:"TokenLocation,omitempty" name:"TokenLocation"` }
type ApiInfo ¶
type ApiInfo struct { // Unique service ID of API. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Service name of API. // Note: this field may return null, indicating that no valid values can be obtained. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Service description of API. // Note: this field may return null, indicating that no valid values can be obtained. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Unique API ID. // Note: this field may return null, indicating that no valid values can be obtained. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API description. // Note: this field may return null, indicating that no valid values can be obtained. ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // API name. // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API type. Valid values: NORMAL (general API), TSF (microservice API). // Note: this field may return null, indicating that no valid values can be obtained. ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. // Note: this field may return null, indicating that no valid values can be obtained. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. // Note: this field may return null, indicating that no valid values can be obtained. AuthType *string `json:"AuthType,omitempty" name:"AuthType"` // OAuth API type. Valid values: NORMAL (business API), �OAUTH (authorization API). // Note: this field may return null, indicating that no valid values can be obtained. ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"` // Unique ID of the authorization API associated with OAuth business API. // Note: this field may return null, indicating that no valid values can be obtained. AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"` // OAuth configuration. // Note: this field may return null, indicating that no valid values can be obtained. OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"` // Whether to enable debugging after purchase (reserved field for the marketplace). // Note: this field may return null, indicating that no valid values can be obtained. IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"` // Request frontend configuration. // Note: this field may return null, indicating that no valid values can be obtained. RequestConfig *RequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"` // Return type. // Note: this field may return null, indicating that no valid values can be obtained. ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"` // Sample response for successful custom response configuration. // Note: this field may return null, indicating that no valid values can be obtained. ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"` // Sample response for failed custom response configuration. // Note: this field may return null, indicating that no valid values can be obtained. ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"` // Custom error code configuration. // Note: this field may return null, indicating that no valid values can be obtained. ResponseErrorCodes []*ErrorCodes `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes"` // Frontend request parameter. // Note: this field may return null, indicating that no valid values can be obtained. RequestParameters []*ReqParameter `json:"RequestParameters,omitempty" name:"RequestParameters"` // API backend service timeout period in seconds. // Note: this field may return null, indicating that no valid values can be obtained. ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"` // API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). // Note: this field may return null, indicating that no valid values can be obtained. ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"` // API backend service configuration. // Note: this field may return null, indicating that no valid values can be obtained. ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"` // API backend service parameter. // Note: this field may return null, indicating that no valid values can be obtained. ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters"` // Constant parameter. // Note: this field may return null, indicating that no valid values can be obtained. ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters"` // Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"` // SCF function name, which takes effect if the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"` // SCF function namespace, which takes effect if the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"` // SCF function version, which takes effect if the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"` // Whether integrated response is enabled. // Note: this field may return null, indicating that no valid values can be obtained. ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"` // SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF` // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"` // SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"` // SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"` // SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"` // SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"` // WebSocket callback address. // Note: this field may return null, indicating that no valid values can be obtained. InternalDomain *string `json:"InternalDomain,omitempty" name:"InternalDomain"` // SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"` // SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. // Note: this field may return null, indicating that no valid values can be obtained. ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"` // List of microservices bound to API. // Note: this field may return null, indicating that no valid values can be obtained. MicroServices []*MicroService `json:"MicroServices,omitempty" name:"MicroServices"` // Microservice details. // Note: this field may return null, indicating that no valid values can be obtained. MicroServicesInfo []*int64 `json:"MicroServicesInfo,omitempty" name:"MicroServicesInfo"` // Load balancing configuration of microservice. // Note: this field may return null, indicating that no valid values can be obtained. ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"` // Health check configuration of microservice. // Note: this field may return null, indicating that no valid values can be obtained. ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"` // Whether to enable CORS. // Note: this field may return null, indicating that no valid values can be obtained. EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"` // Information of tags bound to API. // Note: this field may return null, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Environment information published for API. // Note: this field may return null, indicating that no valid values can be obtained. Environments []*string `json:"Environments,omitempty" name:"Environments"` // Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. // Note: This field may return `null`, indicating that no valid values can be obtained. IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"` // Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. // Note: This field may return `null`, indicating that no valid values can be obtained. IsBase64Trigger *bool `json:"IsBase64Trigger,omitempty" name:"IsBase64Trigger"` // Header trigger rules. The number of rules cannot exceed 10. // Note: This field may return `null`, indicating that no valid values can be obtained. Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitempty" name:"Base64EncodedTriggerRules"` }
type ApiInfoSummary ¶
type ApiInfoSummary struct { // Total number of APIs that can use this plugin TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Information of the APIs that can use this plugin ApiSet []*AvailableApiInfo `json:"ApiSet,omitempty" name:"ApiSet"` }
type ApiKey ¶
type ApiKey struct { // Created API key ID. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` // Created API key. AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"` // Key type. Valid values: auto, manual. AccessKeyType *string `json:"AccessKeyType,omitempty" name:"AccessKeyType"` // Custom key name. SecretName *string `json:"SecretName,omitempty" name:"SecretName"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Key status. 0: disabled. 1: enabled. Status *int64 `json:"Status,omitempty" name:"Status"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` }
type ApiKeysStatus ¶
type ApiKeysStatus struct { // Number of eligible API keys. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // API key list. // Note: this field may return null, indicating that no valid values can be obtained. ApiKeySet []*ApiKey `json:"ApiKeySet,omitempty" name:"ApiKeySet"` }
type ApiRequestConfig ¶
type ApiUsagePlan ¶
type ApiUsagePlan struct { // Unique service ID. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID. // Note: this field may return null, indicating that no valid values can be obtained. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API name. // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API path. // Note: this field may return null, indicating that no valid values can be obtained. Path *string `json:"Path,omitempty" name:"Path"` // API method. // Note: this field may return null, indicating that no valid values can be obtained. Method *string `json:"Method,omitempty" name:"Method"` // Unique usage plan ID. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Usage plan name. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Usage plan description. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Service environment bound to usage plan. // Note: this field may return null, indicating that no valid values can be obtained. Environment *string `json:"Environment,omitempty" name:"Environment"` // Used quota. // Note: this field may return null, indicating that no valid values can be obtained. InUseRequestNum *int64 `json:"InUseRequestNum,omitempty" name:"InUseRequestNum"` // Total number of requests allowed. `-1` indicates no limit. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Request QPS upper limit. `-1` indicates no limit. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` // Usage plan creation time. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time of usage plan. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Service name. // Note: this field may return null, indicating that no valid values can be obtained. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` }
type ApiUsagePlanSet ¶
type ApiUsagePlanSet struct { // Total number of usage plans bound to API. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of usage plans bound to API. // Note: this field may return null, indicating that no valid values can be obtained. ApiUsagePlanList []*ApiUsagePlan `json:"ApiUsagePlanList,omitempty" name:"ApiUsagePlanList"` }
type ApisStatus ¶
type ApisStatus struct { // Number of eligible APIs. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // API list. ApiIdStatusSet []*DesApisStatus `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet"` }
type AttachPluginRequest ¶
type AttachPluginRequest struct { *tchttp.BaseRequest // ID of the plugin to be bound PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // API environment EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // List of APIs bound with the plugin ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewAttachPluginRequest ¶
func NewAttachPluginRequest() (request *AttachPluginRequest)
func (*AttachPluginRequest) FromJsonString ¶
func (r *AttachPluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AttachPluginRequest) ToJsonString ¶
func (r *AttachPluginRequest) ToJsonString() string
type AttachPluginResponse ¶
type AttachPluginResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAttachPluginResponse ¶
func NewAttachPluginResponse() (response *AttachPluginResponse)
func (*AttachPluginResponse) FromJsonString ¶
func (r *AttachPluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AttachPluginResponse) ToJsonString ¶
func (r *AttachPluginResponse) ToJsonString() string
type AttachedApiInfo ¶
type AttachedApiInfo struct { // ID of the service to which the API belongs ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Name of the service to which the API belongs ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Description of the service to which the API belongs // Note: this field may return null, indicating that no valid values can be obtained. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // API ID ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API name ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API description // Note: this field may return null, indicating that no valid values can be obtained. ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"` // Environment of the API bound with the plugin Environment *string `json:"Environment,omitempty" name:"Environment"` // Time when the plugin was bound to the API AttachedTime *string `json:"AttachedTime,omitempty" name:"AttachedTime"` }
type AttachedApiSummary ¶
type AttachedApiSummary struct { // Number of APIs bound with the plugin TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Information of the API bound with the plugin AttachedApis []*AttachedApiInfo `json:"AttachedApis,omitempty" name:"AttachedApis"` }
type AvailableApiInfo ¶
type AvailableApiInfo struct { // API ID ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API name ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API type ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API path Path *string `json:"Path,omitempty" name:"Path"` // API method Method *string `json:"Method,omitempty" name:"Method"` // Whether the API is bound with another plugin // Note: this field may return null, indicating that no valid values can be obtained. AttachedOtherPlugin *bool `json:"AttachedOtherPlugin,omitempty" name:"AttachedOtherPlugin"` // Whether the API is bound with the current plugin // Note: this field may return null, indicating that no valid values can be obtained. IsAttached *bool `json:"IsAttached,omitempty" name:"IsAttached"` }
type Base64EncodedTriggerRule ¶
type Base64EncodedTriggerRule struct { // Header for triggering encoding. Valid values are `Accept` and `Content_Type`, corresponding to the `Accept` and `Content-Type` headers in the data stream request, respectively. Name *string `json:"Name,omitempty" name:"Name"` // Array of header values that can trigger the encoding. Each element in the array can be up to 40 characters, including digits, letters, and special characters (`.`, `+`, `*`, `-`, `/`, and `_`). // // For example, [ // "application/x-vpeg005", // "application/xhtml+xml", // "application/vnd.ms-project", // "application/vnd.rn-rn_music_package" // ] are valid. Value []*string `json:"Value,omitempty" name:"Value"` }
type BindApiAppRequest ¶
type BindApiAppRequest struct { *tchttp.BaseRequest // Unique ID of the application to be bound. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Environment to be bound. Environment *string `json:"Environment,omitempty" name:"Environment"` // Unique ID of the service to be bound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the API to be bound. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` }
func NewBindApiAppRequest ¶
func NewBindApiAppRequest() (request *BindApiAppRequest)
func (*BindApiAppRequest) FromJsonString ¶
func (r *BindApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindApiAppRequest) ToJsonString ¶
func (r *BindApiAppRequest) ToJsonString() string
type BindApiAppResponse ¶
type BindApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewBindApiAppResponse ¶
func NewBindApiAppResponse() (response *BindApiAppResponse)
func (*BindApiAppResponse) FromJsonString ¶
func (r *BindApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindApiAppResponse) ToJsonString ¶
func (r *BindApiAppResponse) ToJsonString() string
type BindEnvironmentRequest ¶
type BindEnvironmentRequest struct { *tchttp.BaseRequest // List of unique IDs of the usage plans to be bound. UsagePlanIds []*string `json:"UsagePlanIds,omitempty" name:"UsagePlanIds"` // Binding type. Valid values: API, SERVICE. Default value: SERVICE. BindType *string `json:"BindType,omitempty" name:"BindType"` // Environment to be bound. Environment *string `json:"Environment,omitempty" name:"Environment"` // Unique ID of the service to be bound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID array, which is required if `bindType` is `API`. ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewBindEnvironmentRequest ¶
func NewBindEnvironmentRequest() (request *BindEnvironmentRequest)
func (*BindEnvironmentRequest) FromJsonString ¶
func (r *BindEnvironmentRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindEnvironmentRequest) ToJsonString ¶
func (r *BindEnvironmentRequest) ToJsonString() string
type BindEnvironmentResponse ¶
type BindEnvironmentResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindEnvironmentResponse) ToJsonString ¶
func (r *BindEnvironmentResponse) ToJsonString() string
type BindIPStrategyRequest ¶
type BindIPStrategyRequest struct { *tchttp.BaseRequest // Unique service ID of the IP policy to be bound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the IP policy to be bound. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Environment to be bound to IP policy. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // List of APIs to be bound to IP policy. BindApiIds []*string `json:"BindApiIds,omitempty" name:"BindApiIds"` }
func NewBindIPStrategyRequest ¶
func NewBindIPStrategyRequest() (request *BindIPStrategyRequest)
func (*BindIPStrategyRequest) FromJsonString ¶
func (r *BindIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindIPStrategyRequest) ToJsonString ¶
func (r *BindIPStrategyRequest) ToJsonString() string
type BindIPStrategyResponse ¶
type BindIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindIPStrategyResponse) ToJsonString ¶
func (r *BindIPStrategyResponse) ToJsonString() string
type BindSecretIdsRequest ¶
type BindSecretIdsRequest struct { *tchttp.BaseRequest // Unique ID of the usage plan to be bound. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Array of IDs of the keys to be bound. AccessKeyIds []*string `json:"AccessKeyIds,omitempty" name:"AccessKeyIds"` }
func NewBindSecretIdsRequest ¶
func NewBindSecretIdsRequest() (request *BindSecretIdsRequest)
func (*BindSecretIdsRequest) FromJsonString ¶
func (r *BindSecretIdsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindSecretIdsRequest) ToJsonString ¶
func (r *BindSecretIdsRequest) ToJsonString() string
type BindSecretIdsResponse ¶
type BindSecretIdsResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindSecretIdsResponse) ToJsonString ¶
func (r *BindSecretIdsResponse) ToJsonString() string
type BindSubDomainRequest ¶
type BindSubDomainRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom domain name to be bound. SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"` // Protocol supported by service. Valid values: http, https, http&https. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Network type. Valid values: OUTER, INNER. NetType *string `json:"NetType,omitempty" name:"NetType"` // Whether the default path mapping is used. The default value is `true`. If the value is `false`, the custom path mapping will be used and `PathMappingSet` will be required in this case. IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"` // Default domain name. NetSubDomain *string `json:"NetSubDomain,omitempty" name:"NetSubDomain"` // Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if `Protocol` is `https` or `http&https`. CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"` // Custom domain name path mapping. It can contain up to 3 `Environment` values which can be set to only `test`, `prepub`, and `release`, respectively. PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet"` // Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding. IsForcedHttps *bool `json:"IsForcedHttps,omitempty" name:"IsForcedHttps"` }
func NewBindSubDomainRequest ¶
func NewBindSubDomainRequest() (request *BindSubDomainRequest)
func (*BindSubDomainRequest) FromJsonString ¶
func (r *BindSubDomainRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindSubDomainRequest) ToJsonString ¶
func (r *BindSubDomainRequest) ToJsonString() string
type BindSubDomainResponse ¶
type BindSubDomainResponse struct { *tchttp.BaseResponse Response *struct { // Whether binding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindSubDomainResponse) ToJsonString ¶
func (r *BindSubDomainResponse) ToJsonString() string
type BuildAPIDocRequest ¶
type BuildAPIDocRequest struct { *tchttp.BaseRequest // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` }
func NewBuildAPIDocRequest ¶
func NewBuildAPIDocRequest() (request *BuildAPIDocRequest)
func (*BuildAPIDocRequest) FromJsonString ¶
func (r *BuildAPIDocRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BuildAPIDocRequest) ToJsonString ¶
func (r *BuildAPIDocRequest) ToJsonString() string
type BuildAPIDocResponse ¶
type BuildAPIDocResponse struct { *tchttp.BaseResponse Response *struct { // Whether the operation succeeded Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BuildAPIDocResponse) ToJsonString ¶
func (r *BuildAPIDocResponse) ToJsonString() string
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AttachPlugin ¶
func (c *Client) AttachPlugin(request *AttachPluginRequest) (response *AttachPluginResponse, err error)
AttachPlugin This API is used to bind a plugin to an API.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource" UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin"
func (*Client) AttachPluginWithContext ¶
func (c *Client) AttachPluginWithContext(ctx context.Context, request *AttachPluginRequest) (response *AttachPluginResponse, err error)
AttachPlugin This API is used to bind a plugin to an API.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" LIMITEXCEEDED_SERVICECOUNTFORPLUGINLIMITEXCEEDED = "LimitExceeded.ServiceCountForPluginLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource" UNSUPPORTEDOPERATION_ATTACHPLUGIN = "UnsupportedOperation.AttachPlugin"
func (*Client) BindApiApp ¶
func (c *Client) BindApiApp(request *BindApiAppRequest) (response *BindApiAppResponse, err error)
BindApiApp This API is used to bind an application to an API.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv" LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
func (*Client) BindApiAppWithContext ¶
func (c *Client) BindApiAppWithContext(ctx context.Context, request *BindApiAppRequest) (response *BindApiAppResponse, err error)
BindApiApp This API is used to bind an application to an API.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv" LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
func (*Client) BindEnvironment ¶
func (c *Client) BindEnvironment(request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
BindEnvironment This API is used to bind a usage plan to a service or API.
After you publish a service to an environment, if the API requires authentication and can be called only when it is bound to a usage plan, you can use this API to bind a usage plan to the specified environment.
Currently, a usage plan can be bound to an API; however, under the same service, usage plans bound to a service and usage plans bound to an API cannot coexist. Therefore, in an environment to which a service-level usage plan has already been bound, please use the `DemoteServiceUsagePlan` API to degrade it.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) BindEnvironmentWithContext ¶
func (c *Client) BindEnvironmentWithContext(ctx context.Context, request *BindEnvironmentRequest) (response *BindEnvironmentResponse, err error)
BindEnvironment This API is used to bind a usage plan to a service or API.
After you publish a service to an environment, if the API requires authentication and can be called only when it is bound to a usage plan, you can use this API to bind a usage plan to the specified environment.
Currently, a usage plan can be bound to an API; however, under the same service, usage plans bound to a service and usage plans bound to an API cannot coexist. Therefore, in an environment to which a service-level usage plan has already been bound, please use the `DemoteServiceUsagePlan` API to degrade it.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) BindIPStrategy ¶
func (c *Client) BindIPStrategy(request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
BindIPStrategy This API is used to bind an IP policy to an API.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) BindIPStrategyWithContext ¶
func (c *Client) BindIPStrategyWithContext(ctx context.Context, request *BindIPStrategyRequest) (response *BindIPStrategyResponse, err error)
BindIPStrategy This API is used to bind an IP policy to an API.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) BindSecretIds ¶
func (c *Client) BindSecretIds(request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
BindSecretIds This API is used to bind a key to a usage plan.
You can bind a key to a usage plan and bind the usage plan to an environment where a service is published, so that callers can use the key to call APIs in the service. You can use this API to bind a key to a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey"
func (*Client) BindSecretIdsWithContext ¶
func (c *Client) BindSecretIdsWithContext(ctx context.Context, request *BindSecretIdsRequest) (response *BindSecretIdsResponse, err error)
BindSecretIds This API is used to bind a key to a usage plan.
You can bind a key to a usage plan and bind the usage plan to an environment where a service is published, so that callers can use the key to call APIs in the service. You can use this API to bind a key to a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDACCESSKEYIDS = "InvalidParameterValue.InvalidAccessKeyIds" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_ALREADYBINDUSAGEPLAN = "UnsupportedOperation.AlreadyBindUsagePlan" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDAPIKEY = "UnsupportedOperation.UnsupportedBindApiKey"
func (*Client) BindSubDomain ¶
func (c *Client) BindSubDomain(request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
BindSubDomain This API is used to bind a custom domain name to a service.
Each service in API Gateway provides a default domain name for users to call. If you want to use your own domain name, you can bind a custom domain name to the target service. After getting the ICP filing and configuring the CNAME record between the custom and default domain names, you can directly call the custom domain name.
error code that may be returned:
FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit" FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError" FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired" FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError" FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify" FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError" FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail" FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull" FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError" FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull" FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat" FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError" FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService" FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService" FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList" FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian" FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError" FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping" FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" INTERNALERROR = "InternalError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol" LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit" LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) BindSubDomainWithContext ¶
func (c *Client) BindSubDomainWithContext(ctx context.Context, request *BindSubDomainRequest) (response *BindSubDomainResponse, err error)
BindSubDomain This API is used to bind a custom domain name to a service.
Each service in API Gateway provides a default domain name for users to call. If you want to use your own domain name, you can bind a custom domain name to the target service. After getting the ICP filing and configuring the CNAME record between the custom and default domain names, you can directly call the custom domain name.
error code that may be returned:
FAILEDOPERATION_CERTIFICATEIDENTERPRISEWAITSUBMIT = "FailedOperation.CertificateIdEnterpriseWaitSubmit" FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError" FAILEDOPERATION_CERTIFICATEIDEXPIRED = "FailedOperation.CertificateIdExpired" FAILEDOPERATION_CERTIFICATEIDINFOERROR = "FailedOperation.CertificateIdInfoError" FAILEDOPERATION_CERTIFICATEIDUNDERVERIFY = "FailedOperation.CertificateIdUnderVerify" FAILEDOPERATION_CERTIFICATEIDUNKNOWNERROR = "FailedOperation.CertificateIdUnknownError" FAILEDOPERATION_CERTIFICATEIDVERIFYFAIL = "FailedOperation.CertificateIdVerifyFail" FAILEDOPERATION_CERTIFICATEISNULL = "FailedOperation.CertificateIsNull" FAILEDOPERATION_DEFINEMAPPINGENVIRONMENTERROR = "FailedOperation.DefineMappingEnvironmentError" FAILEDOPERATION_DEFINEMAPPINGNOTNULL = "FailedOperation.DefineMappingNotNull" FAILEDOPERATION_DEFINEMAPPINGPARAMREPEAT = "FailedOperation.DefineMappingParamRepeat" FAILEDOPERATION_DEFINEMAPPINGPATHERROR = "FailedOperation.DefineMappingPathError" FAILEDOPERATION_DOMAINALREADYBINDOTHERSERVICE = "FailedOperation.DomainAlreadyBindOtherService" FAILEDOPERATION_DOMAINALREADYBINDSERVICE = "FailedOperation.DomainAlreadyBindService" FAILEDOPERATION_DOMAININBLACKLIST = "FailedOperation.DomainInBlackList" FAILEDOPERATION_DOMAINNEEDBEIAN = "FailedOperation.DomainNeedBeian" FAILEDOPERATION_DOMAINRESOLVEERROR = "FailedOperation.DomainResolveError" FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" FAILEDOPERATION_ISDEFAULTMAPPING = "FailedOperation.IsDefaultMapping" FAILEDOPERATION_NETSUBDOMAINERROR = "FailedOperation.NetSubDomainError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" INTERNALERROR = "InternalError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDPROCOTOL = "InvalidParameterValue.InvalidProcotol" LIMITEXCEEDED_EXCEEDEDDEFINEMAPPINGLIMIT = "LimitExceeded.ExceededDefineMappingLimit" LIMITEXCEEDED_EXCEEDEDDOMAINLIMIT = "LimitExceeded.ExceededDomainLimit" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) BuildAPIDoc ¶
func (c *Client) BuildAPIDoc(request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
BuildAPIDoc This API is used to build an API document.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) BuildAPIDocWithContext ¶
func (c *Client) BuildAPIDocWithContext(ctx context.Context, request *BuildAPIDocRequest) (response *BuildAPIDocResponse, err error)
BuildAPIDoc This API is used to build an API document.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) CreateAPIDoc ¶
func (c *Client) CreateAPIDoc(request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
CreateAPIDoc This API is used to create an API document.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen" FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment" FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded" MISSINGPARAMETER = "MissingParameter" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateAPIDocWithContext ¶
func (c *Client) CreateAPIDocWithContext(ctx context.Context, request *CreateAPIDocRequest) (response *CreateAPIDocResponse, err error)
CreateAPIDoc This API is used to create an API document.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen" FAILEDOPERATION_APIBINDENVIRONMENT = "FailedOperation.ApiBindEnvironment" FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_APIDOCLIMITEXCEEDED = "LimitExceeded.APIDocLimitExceeded" MISSINGPARAMETER = "MissingParameter" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateApi ¶
func (c *Client) CreateApi(request *CreateApiRequest) (response *CreateApiResponse, err error)
CreateApi This API is used to create an API. Before creating an API, you need to create a service, as each API belongs to a certain service.
error code that may be returned:
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded" RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType" UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType"
func (*Client) CreateApiApp ¶
func (c *Client) CreateApiApp(request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)
CreateApiApp This API is used to create an application.
error code that may be returned:
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded" LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
func (*Client) CreateApiAppWithContext ¶
func (c *Client) CreateApiAppWithContext(ctx context.Context, request *CreateApiAppRequest) (response *CreateApiAppResponse, err error)
CreateApiApp This API is used to create an application.
error code that may be returned:
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_APIAPPCOUNTLIMITEXCEEDED = "LimitExceeded.ApiAppCountLimitExceeded" LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
func (*Client) CreateApiKey ¶
func (c *Client) CreateApiKey(request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
CreateApiKey This API is used to create an API key pair.
error code that may be returned:
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
func (*Client) CreateApiKeyWithContext ¶
func (c *Client) CreateApiKeyWithContext(ctx context.Context, request *CreateApiKeyRequest) (response *CreateApiKeyResponse, err error)
CreateApiKey This API is used to create an API key pair.
error code that may be returned:
FAILEDOPERATION_ACCESSKEYEXIST = "FailedOperation.AccessKeyExist" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_APIKEYCOUNTLIMITEXCEEDED = "LimitExceeded.ApiKeyCountLimitExceeded"
func (*Client) CreateApiWithContext ¶
func (c *Client) CreateApiWithContext(ctx context.Context, request *CreateApiRequest) (response *CreateApiResponse, err error)
CreateApi This API is used to create an API. Before creating an API, you need to create a service, as each API belongs to a certain service.
error code that may be returned:
FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" FAILEDOPERATION_SCFERROR = "FailedOperation.ScfError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_ILLEGALPROXYIP = "InvalidParameterValue.IllegalProxyIp" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDAPITYPE = "InvalidParameterValue.InvalidApiType" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEMOCKRETURNMESSAGE = "InvalidParameterValue.InvalidServiceMockReturnMessage" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAMETERS = "InvalidParameterValue.InvalidServiceParameters" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded" RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType" UNSUPPORTEDOPERATION_UNSUPPORTEDNETTYPE = "UnsupportedOperation.UnsupportedNetType"
func (*Client) CreateIPStrategy ¶
func (c *Client) CreateIPStrategy(request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
CreateIPStrategy This API is used to create a service IP policy.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreateIPStrategyWithContext ¶
func (c *Client) CreateIPStrategyWithContext(ctx context.Context, request *CreateIPStrategyRequest) (response *CreateIPStrategyResponse, err error)
CreateIPStrategy This API is used to create a service IP policy.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreatePlugin ¶
func (c *Client) CreatePlugin(request *CreatePluginRequest) (response *CreatePluginResponse, err error)
CreatePlugin This API is used to create an API Gateway plugin.
error code that may be returned:
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam" MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreatePluginWithContext ¶
func (c *Client) CreatePluginWithContext(ctx context.Context, request *CreatePluginRequest) (response *CreatePluginResponse, err error)
CreatePlugin This API is used to create an API Gateway plugin.
error code that may be returned:
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_DUPLICATEPLUGINCONFIG = "InvalidParameterValue.DuplicatePluginConfig" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDCONDITION = "InvalidParameterValue.InvalidCondition" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPLUGINCONFIG = "InvalidParameterValue.InvalidPluginConfig" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam" MISSINGPARAMETER_PLUGINCONFIG = "MissingParameter.PluginConfig" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreateService ¶
func (c *Client) CreateService(request *CreateServiceRequest) (response *CreateServiceResponse, err error)
CreateService This API is used to create a service.
The maximum unit in API Gateway is service. Multiple APIs can be created in one service, and each service has a default domain name for users to call. You can also bind your own custom domain name to a service.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist" FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError" INTERNALERROR = "InternalError" INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded" LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded" MISSINGPARAMETER = "MissingParameter" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreateServiceWithContext ¶
func (c *Client) CreateServiceWithContext(ctx context.Context, request *CreateServiceRequest) (response *CreateServiceResponse, err error)
CreateService This API is used to create a service.
The maximum unit in API Gateway is service. Multiple APIs can be created in one service, and each service has a default domain name for users to call. You can also bind your own custom domain name to a service.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTEXIST = "FailedOperation.InstanceNotExist" FAILEDOPERATION_TAGBINDSERVICEERROR = "FailedOperation.TagBindServiceError" INTERNALERROR = "InternalError" INTERNALERROR_CAUTHEXCEPTION = "InternalError.CauthException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERVALUELIMITEXCEEDED = "InvalidParameterValue.ParameterValueLimitExceeded" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_IPSTRATEGYLIMITEXCEEDED = "LimitExceeded.IpStrategyLimitExceeded" LIMITEXCEEDED_SERVICECOUNTLIMITEXCEEDED = "LimitExceeded.ServiceCountLimitExceeded" MISSINGPARAMETER = "MissingParameter" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION_UNCERTIFIEDUSER = "UnauthorizedOperation.UncertifiedUser" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) CreateUsagePlan ¶
func (c *Client) CreateUsagePlan(request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
CreateUsagePlan This API is used to create a usage plan.
To use API Gateway, you need to create a usage plan and bind it to a service environment.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded"
func (*Client) CreateUsagePlanWithContext ¶
func (c *Client) CreateUsagePlanWithContext(ctx context.Context, request *CreateUsagePlanRequest) (response *CreateUsagePlanResponse, err error)
CreateUsagePlan This API is used to create a usage plan.
To use API Gateway, you need to create a usage plan and bind it to a service environment.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_USAGEPLANLIMITEXCEEDED = "LimitExceeded.UsagePlanLimitExceeded"
func (*Client) DeleteAPIDoc ¶
func (c *Client) DeleteAPIDoc(request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
DeleteAPIDoc This API is used to delete an API document.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteAPIDocWithContext ¶
func (c *Client) DeleteAPIDocWithContext(ctx context.Context, request *DeleteAPIDocRequest) (response *DeleteAPIDocResponse, err error)
DeleteAPIDoc This API is used to delete an API document.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteApi ¶
func (c *Client) DeleteApi(request *DeleteApiRequest) (response *DeleteApiResponse, err error)
DeleteApi This API is used to delete a created API.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) DeleteApiApp ¶
func (c *Client) DeleteApiApp(request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)
DeleteApiApp This API is used to delete a created application.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) DeleteApiAppWithContext ¶
func (c *Client) DeleteApiAppWithContext(ctx context.Context, request *DeleteApiAppRequest) (response *DeleteApiAppResponse, err error)
DeleteApiApp This API is used to delete a created application.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) DeleteApiKey ¶
func (c *Client) DeleteApiKey(request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
DeleteApiKey This API is used to delete an API key pair.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus" UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse"
func (*Client) DeleteApiKeyWithContext ¶
func (c *Client) DeleteApiKeyWithContext(ctx context.Context, request *DeleteApiKeyRequest) (response *DeleteApiKeyResponse, err error)
DeleteApiKey This API is used to delete an API key pair.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus" UNSUPPORTEDOPERATION_RESOURCEISINUSE = "UnsupportedOperation.ResourceIsInUse"
func (*Client) DeleteApiWithContext ¶
func (c *Client) DeleteApiWithContext(ctx context.Context, request *DeleteApiRequest) (response *DeleteApiResponse, err error)
DeleteApi This API is used to delete a created API.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_APIBINDENVIRONMEN = "FailedOperation.ApiBindEnvironmen" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) DeleteIPStrategy ¶
func (c *Client) DeleteIPStrategy(request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
DeleteIPStrategy This API is used to delete a service IP policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) DeleteIPStrategyWithContext ¶
func (c *Client) DeleteIPStrategyWithContext(ctx context.Context, request *DeleteIPStrategyRequest) (response *DeleteIPStrategyResponse, err error)
DeleteIPStrategy This API is used to delete a service IP policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) DeletePlugin ¶
func (c *Client) DeletePlugin(request *DeletePluginRequest) (response *DeletePluginResponse, err error)
DeletePlugin This API is used to delete an API Gateway plugin.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DeletePluginWithContext ¶
func (c *Client) DeletePluginWithContext(ctx context.Context, request *DeletePluginRequest) (response *DeletePluginResponse, err error)
DeletePlugin This API is used to delete an API Gateway plugin.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DeleteService ¶
func (c *Client) DeleteService(request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)
DeleteService This API is used to delete a service in API Gateway.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService"
func (*Client) DeleteServiceSubDomainMapping ¶
func (c *Client) DeleteServiceSubDomainMapping(request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)
DeleteServiceSubDomainMapping This API is used to delete a custom domain name mapping in a service environment.
You can use this API if you use a custom domain name and custom mapping. Please note that if you delete all mappings in all environments, a failure will be returned when this API is called.
error code that may be returned:
FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) DeleteServiceSubDomainMappingWithContext ¶
func (c *Client) DeleteServiceSubDomainMappingWithContext(ctx context.Context, request *DeleteServiceSubDomainMappingRequest) (response *DeleteServiceSubDomainMappingResponse, err error)
DeleteServiceSubDomainMapping This API is used to delete a custom domain name mapping in a service environment.
You can use this API if you use a custom domain name and custom mapping. Please note that if you delete all mappings in all environments, a failure will be returned when this API is called.
error code that may be returned:
FAILEDOPERATION_DELETEPATHMAPPINGSETERROR = "FailedOperation.DeletePathMappingSetError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) DeleteServiceWithContext ¶
func (c *Client) DeleteServiceWithContext(ctx context.Context, request *DeleteServiceRequest) (response *DeleteServiceResponse, err error)
DeleteService This API is used to delete a service in API Gateway.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETESERVICE = "UnsupportedOperation.UnsupportedDeleteService"
func (*Client) DeleteUsagePlan ¶
func (c *Client) DeleteUsagePlan(request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
DeleteUsagePlan This API is used to delete a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"
func (*Client) DeleteUsagePlanWithContext ¶
func (c *Client) DeleteUsagePlanWithContext(ctx context.Context, request *DeleteUsagePlanRequest) (response *DeleteUsagePlanResponse, err error)
DeleteUsagePlan This API is used to delete a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_USAGEPLANINUSE = "UnsupportedOperation.UsagePlanInUse"
func (*Client) DemoteServiceUsagePlan ¶
func (c *Client) DemoteServiceUsagePlan(request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
DemoteServiceUsagePlan This API is used to degrade a usage plan of a service in an environment to the API level.
This operation will be denied if there are no APIs under the service.
This operation will also be denied if the current environment has not been published.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv"
func (*Client) DemoteServiceUsagePlanWithContext ¶
func (c *Client) DemoteServiceUsagePlanWithContext(ctx context.Context, request *DemoteServiceUsagePlanRequest) (response *DemoteServiceUsagePlanResponse, err error)
DemoteServiceUsagePlan This API is used to degrade a usage plan of a service in an environment to the API level.
This operation will be denied if there are no APIs under the service.
This operation will also be denied if the current environment has not been published.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_NOUSAGEPLANENV = "UnsupportedOperation.NoUsagePlanEnv"
func (*Client) DescribeAPIDocDetail ¶
func (c *Client) DescribeAPIDocDetail(request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
DescribeAPIDocDetail This API is used to query the details of an API document.
error code that may be returned:
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeAPIDocDetailWithContext ¶
func (c *Client) DescribeAPIDocDetailWithContext(ctx context.Context, request *DescribeAPIDocDetailRequest) (response *DescribeAPIDocDetailResponse, err error)
DescribeAPIDocDetail This API is used to query the details of an API document.
error code that may be returned:
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeAPIDocs ¶
func (c *Client) DescribeAPIDocs(request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
DescribeAPIDocs This API is used to query the list of API documents.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeAPIDocsWithContext ¶
func (c *Client) DescribeAPIDocsWithContext(ctx context.Context, request *DescribeAPIDocsRequest) (response *DescribeAPIDocsResponse, err error)
DescribeAPIDocs This API is used to query the list of API documents.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeAllPluginApis ¶
func (c *Client) DescribeAllPluginApis(request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)
DescribeAllPluginApis This API is used to list all APIs that can use this plugin, no matter whether the API is bound with the plugin.
error code that may be returned:
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribeAllPluginApisWithContext ¶
func (c *Client) DescribeAllPluginApisWithContext(ctx context.Context, request *DescribeAllPluginApisRequest) (response *DescribeAllPluginApisResponse, err error)
DescribeAllPluginApis This API is used to list all APIs that can use this plugin, no matter whether the API is bound with the plugin.
error code that may be returned:
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribeApi ¶
func (c *Client) DescribeApi(request *DescribeApiRequest) (response *DescribeApiResponse, err error)
DescribeApi This API (`DescribeApi`) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeApiApp ¶
func (c *Client) DescribeApiApp(request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)
DescribeApiApp This API is used to search for an application by application ID.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
func (*Client) DescribeApiAppBindApisStatus ¶
func (c *Client) DescribeApiAppBindApisStatus(request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)
DescribeApiAppBindApisStatus This API is used to query the list of APIs bound to an application.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
func (*Client) DescribeApiAppBindApisStatusWithContext ¶
func (c *Client) DescribeApiAppBindApisStatusWithContext(ctx context.Context, request *DescribeApiAppBindApisStatusRequest) (response *DescribeApiAppBindApisStatusResponse, err error)
DescribeApiAppBindApisStatus This API is used to query the list of APIs bound to an application.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
func (*Client) DescribeApiAppWithContext ¶
func (c *Client) DescribeApiAppWithContext(ctx context.Context, request *DescribeApiAppRequest) (response *DescribeApiAppResponse, err error)
DescribeApiApp This API is used to search for an application by application ID.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
func (*Client) DescribeApiAppsStatus ¶
func (c *Client) DescribeApiAppsStatus(request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)
DescribeApiAppsStatus This API is used to query the application list.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeApiAppsStatusWithContext ¶
func (c *Client) DescribeApiAppsStatusWithContext(ctx context.Context, request *DescribeApiAppsStatusRequest) (response *DescribeApiAppsStatusResponse, err error)
DescribeApiAppsStatus This API is used to query the application list.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeApiBindApiAppsStatus ¶
func (c *Client) DescribeApiBindApiAppsStatus(request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)
DescribeApiBindApiAppsStatus This API is used to query the list of applications bound to an API.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
func (*Client) DescribeApiBindApiAppsStatusWithContext ¶
func (c *Client) DescribeApiBindApiAppsStatusWithContext(ctx context.Context, request *DescribeApiBindApiAppsStatusRequest) (response *DescribeApiBindApiAppsStatusResponse, err error)
DescribeApiBindApiAppsStatus This API is used to query the list of applications bound to an API.
error code that may be returned:
INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException"
func (*Client) DescribeApiEnvironmentStrategy ¶
func (c *Client) DescribeApiEnvironmentStrategy(request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
DescribeApiEnvironmentStrategy This API is used to display the throttling policies bound to an API.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiEnvironmentStrategyWithContext ¶
func (c *Client) DescribeApiEnvironmentStrategyWithContext(ctx context.Context, request *DescribeApiEnvironmentStrategyRequest) (response *DescribeApiEnvironmentStrategyResponse, err error)
DescribeApiEnvironmentStrategy This API is used to display the throttling policies bound to an API.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiForApiApp ¶
func (c *Client) DescribeApiForApiApp(request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)
DescribeApiForApiApp This API is used to query the details of an API deployed at API Gateway.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiForApiAppWithContext ¶
func (c *Client) DescribeApiForApiAppWithContext(ctx context.Context, request *DescribeApiForApiAppRequest) (response *DescribeApiForApiAppResponse, err error)
DescribeApiForApiApp This API is used to query the details of an API deployed at API Gateway.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiKey ¶
func (c *Client) DescribeApiKey(request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
DescribeApiKey This API is used to query the details of a key.
After creating an API key, you can query its details by using this API.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
func (*Client) DescribeApiKeyWithContext ¶
func (c *Client) DescribeApiKeyWithContext(ctx context.Context, request *DescribeApiKeyRequest) (response *DescribeApiKeyResponse, err error)
DescribeApiKey This API is used to query the details of a key.
After creating an API key, you can query its details by using this API.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId"
func (*Client) DescribeApiKeysStatus ¶
func (c *Client) DescribeApiKeysStatus(request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
DescribeApiKeysStatus This API is used to query the list of keys.
If you have created multiple API key pairs, you can use this API to query the information of one or more keys. This API does not display the `secretKey`.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DescribeApiKeysStatusWithContext ¶
func (c *Client) DescribeApiKeysStatusWithContext(ctx context.Context, request *DescribeApiKeysStatusRequest) (response *DescribeApiKeysStatusResponse, err error)
DescribeApiKeysStatus This API is used to query the list of keys.
If you have created multiple API key pairs, you can use this API to query the information of one or more keys. This API does not display the `secretKey`.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DescribeApiUsagePlan ¶
func (c *Client) DescribeApiUsagePlan(request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
DescribeApiUsagePlan This API is used to query the details of API usage plans in a service.
To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service and APIs under it.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiUsagePlanWithContext ¶
func (c *Client) DescribeApiUsagePlanWithContext(ctx context.Context, request *DescribeApiUsagePlanRequest) (response *DescribeApiUsagePlanResponse, err error)
DescribeApiUsagePlan This API is used to query the details of API usage plans in a service.
To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service and APIs under it.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeApiWithContext ¶
func (c *Client) DescribeApiWithContext(ctx context.Context, request *DescribeApiRequest) (response *DescribeApiResponse, err error)
DescribeApi This API (`DescribeApi`) is used to query the details of the APIs users manage via Tencent Cloud API Gateway.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INTERNALERROR = "InternalError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeApisStatus ¶
func (c *Client) DescribeApisStatus(request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)
DescribeApisStatus This API is used to view a certain API or the list of all APIs under a service and relevant information.
error code that may be returned:
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeApisStatusWithContext ¶
func (c *Client) DescribeApisStatusWithContext(ctx context.Context, request *DescribeApisStatusRequest) (response *DescribeApisStatusResponse, err error)
DescribeApisStatus This API is used to view a certain API or the list of all APIs under a service and relevant information.
error code that may be returned:
FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) DescribeIPStrategy ¶
func (c *Client) DescribeIPStrategy(request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)
DescribeIPStrategy This API is used to query IP policy details.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeIPStrategyApisStatus ¶
func (c *Client) DescribeIPStrategyApisStatus(request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)
DescribeIPStrategyApisStatus This API is used to query the list of APIs to which an IP policy can be bound, i.e., the difference set between all APIs under the service and the APIs already bound to the policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) DescribeIPStrategyApisStatusWithContext ¶
func (c *Client) DescribeIPStrategyApisStatusWithContext(ctx context.Context, request *DescribeIPStrategyApisStatusRequest) (response *DescribeIPStrategyApisStatusResponse, err error)
DescribeIPStrategyApisStatus This API is used to query the list of APIs to which an IP policy can be bound, i.e., the difference set between all APIs under the service and the APIs already bound to the policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) DescribeIPStrategyWithContext ¶
func (c *Client) DescribeIPStrategyWithContext(ctx context.Context, request *DescribeIPStrategyRequest) (response *DescribeIPStrategyResponse, err error)
DescribeIPStrategy This API is used to query IP policy details.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeIPStrategysStatus ¶
func (c *Client) DescribeIPStrategysStatus(request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
DescribeIPStrategysStatus This API is used to query the list of service IP policies.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeIPStrategysStatusWithContext ¶
func (c *Client) DescribeIPStrategysStatusWithContext(ctx context.Context, request *DescribeIPStrategysStatusRequest) (response *DescribeIPStrategysStatusResponse, err error)
DescribeIPStrategysStatus This API is used to query the list of service IP policies.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeLogSearch ¶
func (c *Client) DescribeLogSearch(request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
DescribeLogSearch This API is used to search for logs.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DescribeLogSearchWithContext ¶
func (c *Client) DescribeLogSearchWithContext(ctx context.Context, request *DescribeLogSearchRequest) (response *DescribeLogSearchResponse, err error)
DescribeLogSearch This API is used to search for logs.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DescribePlugin ¶
func (c *Client) DescribePlugin(request *DescribePluginRequest) (response *DescribePluginResponse, err error)
DescribePlugin This API is used to query the plugin details by plugin ID.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribePluginApis ¶
func (c *Client) DescribePluginApis(request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)
DescribePluginApis This API is used to query APIs bound with a specified plugin.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribePluginApisWithContext ¶
func (c *Client) DescribePluginApisWithContext(ctx context.Context, request *DescribePluginApisRequest) (response *DescribePluginApisResponse, err error)
DescribePluginApis This API is used to query APIs bound with a specified plugin.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribePluginWithContext ¶
func (c *Client) DescribePluginWithContext(ctx context.Context, request *DescribePluginRequest) (response *DescribePluginResponse, err error)
DescribePlugin This API is used to query the plugin details by plugin ID.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribeService ¶
func (c *Client) DescribeService(request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)
DescribeService This API is used to query the details of a service, such as its description, domain name, protocol, creation time, and releases.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribeServiceEnvironmentList ¶
func (c *Client) DescribeServiceEnvironmentList(request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)
DescribeServiceEnvironmentList This API is used to query the list of environments under a service. All environments and their statuses under the queried service will be returned.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceEnvironmentListWithContext ¶
func (c *Client) DescribeServiceEnvironmentListWithContext(ctx context.Context, request *DescribeServiceEnvironmentListRequest) (response *DescribeServiceEnvironmentListResponse, err error)
DescribeServiceEnvironmentList This API is used to query the list of environments under a service. All environments and their statuses under the queried service will be returned.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceEnvironmentReleaseHistory ¶
func (c *Client) DescribeServiceEnvironmentReleaseHistory(request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
DescribeServiceEnvironmentReleaseHistory This API is used to query the release history in a service environment.
A service can only be used when it is published to an environment after creation. This API is used to query the release history in an environment under a service.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceEnvironmentReleaseHistoryWithContext ¶
func (c *Client) DescribeServiceEnvironmentReleaseHistoryWithContext(ctx context.Context, request *DescribeServiceEnvironmentReleaseHistoryRequest) (response *DescribeServiceEnvironmentReleaseHistoryResponse, err error)
DescribeServiceEnvironmentReleaseHistory This API is used to query the release history in a service environment.
A service can only be used when it is published to an environment after creation. This API is used to query the release history in an environment under a service.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceEnvironmentStrategy ¶
func (c *Client) DescribeServiceEnvironmentStrategy(request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
DescribeServiceEnvironmentStrategy This API is used to display a service throttling policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceEnvironmentStrategyWithContext ¶
func (c *Client) DescribeServiceEnvironmentStrategyWithContext(ctx context.Context, request *DescribeServiceEnvironmentStrategyRequest) (response *DescribeServiceEnvironmentStrategyResponse, err error)
DescribeServiceEnvironmentStrategy This API is used to display a service throttling policy.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceForApiApp ¶
func (c *Client) DescribeServiceForApiApp(request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)
DescribeServiceForApiApp This API is used to query the details of a service, such as its description, domain name, and protocol.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceForApiAppWithContext ¶
func (c *Client) DescribeServiceForApiAppWithContext(ctx context.Context, request *DescribeServiceForApiAppRequest) (response *DescribeServiceForApiAppResponse, err error)
DescribeServiceForApiApp This API is used to query the details of a service, such as its description, domain name, and protocol.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceReleaseVersion ¶
func (c *Client) DescribeServiceReleaseVersion(request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
DescribeServiceReleaseVersion This API is used to query the list of all published versions under a service.
A service is generally published on several versions. This API can be used to query the published versions.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceReleaseVersionWithContext ¶
func (c *Client) DescribeServiceReleaseVersionWithContext(ctx context.Context, request *DescribeServiceReleaseVersionRequest) (response *DescribeServiceReleaseVersionResponse, err error)
DescribeServiceReleaseVersion This API is used to query the list of all published versions under a service.
A service is generally published on several versions. This API can be used to query the published versions.
error code that may be returned:
RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceSubDomainMappings ¶
func (c *Client) DescribeServiceSubDomainMappings(request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
DescribeServiceSubDomainMappings This API is used to query the path mappings of a custom domain name.
In API Gateway, you can bind a custom domain name to a service and map its paths. You can customize different path mappings to up to 3 environments under the service. This API is used to query the list of path mappings of a custom domain name bound to a service.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
func (*Client) DescribeServiceSubDomainMappingsWithContext ¶
func (c *Client) DescribeServiceSubDomainMappingsWithContext(ctx context.Context, request *DescribeServiceSubDomainMappingsRequest) (response *DescribeServiceSubDomainMappingsResponse, err error)
DescribeServiceSubDomainMappings This API is used to query the path mappings of a custom domain name.
In API Gateway, you can bind a custom domain name to a service and map its paths. You can customize different path mappings to up to 3 environments under the service. This API is used to query the list of path mappings of a custom domain name bound to a service.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError"
func (*Client) DescribeServiceSubDomains ¶
func (c *Client) DescribeServiceSubDomains(request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
DescribeServiceSubDomains This API is used to query the list of custom domain names.
In API Gateway, you can bind custom domain names to a service for service call. This API is used to query the list of custom domain names bound to a service.
error code that may be returned:
FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceSubDomainsWithContext ¶
func (c *Client) DescribeServiceSubDomainsWithContext(ctx context.Context, request *DescribeServiceSubDomainsRequest) (response *DescribeServiceSubDomainsResponse, err error)
DescribeServiceSubDomains This API is used to query the list of custom domain names.
In API Gateway, you can bind custom domain names to a service for service call. This API is used to query the list of custom domain names bound to a service.
error code that may be returned:
FAILEDOPERATION_DESCRIBESERVICESUBDOMAINSERROR = "FailedOperation.DescribeServiceSubDomainsError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceUsagePlan ¶
func (c *Client) DescribeServiceUsagePlan(request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
DescribeServiceUsagePlan This API is used to query the details of usage plans in a service.
To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceUsagePlanWithContext ¶
func (c *Client) DescribeServiceUsagePlanWithContext(ctx context.Context, request *DescribeServiceUsagePlanRequest) (response *DescribeServiceUsagePlanResponse, err error)
DescribeServiceUsagePlan This API is used to query the details of usage plans in a service.
To make authentication and throttling for a service take effect, you need to bind a usage plan to it. This API is used to query all usage plans bound to a service.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) DescribeServiceWithContext ¶
func (c *Client) DescribeServiceWithContext(ctx context.Context, request *DescribeServiceRequest) (response *DescribeServiceResponse, err error)
DescribeService This API is used to query the details of a service, such as its description, domain name, protocol, creation time, and releases.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DescribeServicesStatus ¶
func (c *Client) DescribeServicesStatus(request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)
DescribeServicesStatus This API is used to query the list of one or more services and return relevant domain name, time, and other information.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeServicesStatusWithContext ¶
func (c *Client) DescribeServicesStatusWithContext(ctx context.Context, request *DescribeServicesStatusRequest) (response *DescribeServicesStatusResponse, err error)
DescribeServicesStatus This API is used to query the list of one or more services and return relevant domain name, time, and other information.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDTAGVALUES = "InvalidParameterValue.InvalidTagValues" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeUsagePlan ¶
func (c *Client) DescribeUsagePlan(request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)
DescribeUsagePlan This API is used to query the details of a usage plan, such as its name, QPS, creation time, and bound environment.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlanEnvironments ¶
func (c *Client) DescribeUsagePlanEnvironments(request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)
DescribeUsagePlanEnvironments This API is used to query the list of environments bound to a usage plan.
After binding a usage plan to environments, you can use this API to query all service environments bound to the usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlanEnvironmentsWithContext ¶
func (c *Client) DescribeUsagePlanEnvironmentsWithContext(ctx context.Context, request *DescribeUsagePlanEnvironmentsRequest) (response *DescribeUsagePlanEnvironmentsResponse, err error)
DescribeUsagePlanEnvironments This API is used to query the list of environments bound to a usage plan.
After binding a usage plan to environments, you can use this API to query all service environments bound to the usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlanSecretIds ¶
func (c *Client) DescribeUsagePlanSecretIds(request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
DescribeUsagePlanSecretIds This API is used to query the list of keys bound to a usage plan.
In API Gateway, a usage plan can be bound to multiple key pairs. You can use this API to query the list of keys bound to it.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlanSecretIdsWithContext ¶
func (c *Client) DescribeUsagePlanSecretIdsWithContext(ctx context.Context, request *DescribeUsagePlanSecretIdsRequest) (response *DescribeUsagePlanSecretIdsResponse, err error)
DescribeUsagePlanSecretIds This API is used to query the list of keys bound to a usage plan.
In API Gateway, a usage plan can be bound to multiple key pairs. You can use this API to query the list of keys bound to it.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlanWithContext ¶
func (c *Client) DescribeUsagePlanWithContext(ctx context.Context, request *DescribeUsagePlanRequest) (response *DescribeUsagePlanResponse, err error)
DescribeUsagePlan This API is used to query the details of a usage plan, such as its name, QPS, creation time, and bound environment.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) DescribeUsagePlansStatus ¶
func (c *Client) DescribeUsagePlansStatus(request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
DescribeUsagePlansStatus This API is used to query the list of usage plans.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DescribeUsagePlansStatusWithContext ¶
func (c *Client) DescribeUsagePlansStatusWithContext(ctx context.Context, request *DescribeUsagePlansStatusRequest) (response *DescribeUsagePlansStatusResponse, err error)
DescribeUsagePlansStatus This API is used to query the list of usage plans.
error code that may be returned:
INVALIDPARAMETERVALUE_INVALIDFILTERNOTSUPPORTEDNAME = "InvalidParameterValue.InvalidFilterNotSupportedName" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion"
func (*Client) DetachPlugin ¶
func (c *Client) DetachPlugin(request *DetachPluginRequest) (response *DetachPluginResponse, err error)
DetachPlugin This API is used to unbind an API from the plugin.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds" INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DetachPluginWithContext ¶
func (c *Client) DetachPluginWithContext(ctx context.Context, request *DetachPluginRequest) (response *DetachPluginResponse, err error)
DetachPlugin This API is used to unbind an API from the plugin.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDAPIIDS = "InvalidParameterValue.InvalidApiIds" INVALIDPARAMETERVALUE_INVALIDENVSTATUS = "InvalidParameterValue.InvalidEnvStatus" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource"
func (*Client) DisableApiKey ¶
func (c *Client) DisableApiKey(request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
DisableApiKey This API is used to disable an API key.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList" UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"
func (*Client) DisableApiKeyWithContext ¶
func (c *Client) DisableApiKeyWithContext(ctx context.Context, request *DisableApiKeyRequest) (response *DisableApiKeyResponse, err error)
DisableApiKey This API is used to disable an API key.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList" UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"
func (*Client) EnableApiKey ¶
func (c *Client) EnableApiKey(request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
EnableApiKey This API is used to enable a disabled API key.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList" UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"
func (*Client) EnableApiKeyWithContext ¶
func (c *Client) EnableApiKeyWithContext(ctx context.Context, request *EnableApiKeyRequest) (response *EnableApiKeyResponse, err error)
EnableApiKey This API is used to enable a disabled API key.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList" UNSUPPORTEDOPERATION_UNSUPPORTEDUPDATEAPIKEY = "UnsupportedOperation.UnsupportedUpdateApiKey"
func (*Client) GenerateApiDocument ¶
func (c *Client) GenerateApiDocument(request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
GenerateApiDocument This API is used to automatically generate API documents and SDKs. One document and one SDK will be generated for each environment under each service, respectively.
error code that may be returned:
FAILEDOPERATION_GENERATEAPIDOCUMENTERROR = "FailedOperation.GenerateApiDocumentError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETERVALUE_INVALIDGENLANGUAGE = "InvalidParameterValue.InvalidGenLanguage" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
func (*Client) GenerateApiDocumentWithContext ¶
func (c *Client) GenerateApiDocumentWithContext(ctx context.Context, request *GenerateApiDocumentRequest) (response *GenerateApiDocumentResponse, err error)
GenerateApiDocument This API is used to automatically generate API documents and SDKs. One document and one SDK will be generated for each environment under each service, respectively.
error code that may be returned:
FAILEDOPERATION_GENERATEAPIDOCUMENTERROR = "FailedOperation.GenerateApiDocumentError" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" INVALIDPARAMETERVALUE_INVALIDGENLANGUAGE = "InvalidParameterValue.InvalidGenLanguage" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions"
func (*Client) ModifyAPIDoc ¶
func (c *Client) ModifyAPIDoc(request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
ModifyAPIDoc This API is used to modify an API document.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) ModifyAPIDocWithContext ¶
func (c *Client) ModifyAPIDocWithContext(ctx context.Context, request *ModifyAPIDocRequest) (response *ModifyAPIDocResponse, err error)
ModifyAPIDoc This API is used to modify an API document.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) ModifyApi ¶
func (c *Client) ModifyApi(request *ModifyApiRequest) (response *ModifyApiResponse, err error)
ModifyApi This API is used to modify an API. You can call this API to edit/modify a configured API. The modified API takes effect only after its service is published to the corresponding environment again.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType" UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi" UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
func (*Client) ModifyApiApp ¶
func (c *Client) ModifyApiApp(request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)
ModifyApiApp This API is used to modify a created API.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) ModifyApiAppWithContext ¶
func (c *Client) ModifyApiAppWithContext(ctx context.Context, request *ModifyApiAppRequest) (response *ModifyApiAppResponse, err error)
ModifyApiApp This API is used to modify a created API.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) ModifyApiEnvironmentStrategy ¶
func (c *Client) ModifyApiEnvironmentStrategy(request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
ModifyApiEnvironmentStrategy This API is used to modify an API throttling policy.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
func (*Client) ModifyApiEnvironmentStrategyWithContext ¶
func (c *Client) ModifyApiEnvironmentStrategyWithContext(ctx context.Context, request *ModifyApiEnvironmentStrategyRequest) (response *ModifyApiEnvironmentStrategyResponse, err error)
ModifyApiEnvironmentStrategy This API is used to modify an API throttling policy.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi"
func (*Client) ModifyApiIncrement ¶
func (c *Client) ModifyApiIncrement(request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
ModifyApiIncrement This API is used to incrementally update an API and mainly called by programs (different from `ModifyApi`, which requires that full API parameters be passed in and is suitable for use in the console).
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) ModifyApiIncrementWithContext ¶
func (c *Client) ModifyApiIncrementWithContext(ctx context.Context, request *ModifyApiIncrementRequest) (response *ModifyApiIncrementResponse, err error)
ModifyApiIncrement This API is used to incrementally update an API and mainly called by programs (different from `ModifyApi`, which requires that full API parameters be passed in and is suitable for use in the console).
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_NOTHINGMODIFYFOROAUTH = "InvalidParameterValue.NothingModifyForOauth" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService"
func (*Client) ModifyApiWithContext ¶
func (c *Client) ModifyApiWithContext(ctx context.Context, request *ModifyApiRequest) (response *ModifyApiResponse, err error)
ModifyApi This API is used to modify an API. You can call this API to edit/modify a configured API. The modified API takes effect only after its service is published to the corresponding environment again.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_EBERROR = "FailedOperation.EbError" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" INTERNALERROR_TSFEXCEPTION = "InternalError.TsfException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDAPIBUSINESSTYPE = "InvalidParameterValue.InvalidApiBusinessType" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDCONSTANTPARAMETERS = "InvalidParameterValue.InvalidConstantParameters" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDMETHOD = "InvalidParameterValue.InvalidMethod" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDPUBLICKEY = "InvalidParameterValue.InvalidPublicKey" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_INVALIDWSMETHOD = "InvalidParameterValue.InvalidWSMethod" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_LIMITEXCEEDED = "InvalidParameterValue.LimitExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_PARAMETERNOTMATCH = "InvalidParameterValue.ParameterNotMatch" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" LIMITEXCEEDED_APICOUNTLIMITEXCEEDED = "LimitExceeded.ApiCountLimitExceeded" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDOAUTHAPI = "ResourceNotFound.InvalidOauthApi" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction" UNSUPPORTEDOPERATION_INVALIDENDPOINTTYPE = "UnsupportedOperation.InvalidEndpointType" UNSUPPORTEDOPERATION_MODIFYEIAMAUTHAPI = "UnsupportedOperation.ModifyEIAMAuthApi" UNSUPPORTEDOPERATION_MODIFYPROTOCOL = "UnsupportedOperation.ModifyProtocol" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated"
func (*Client) ModifyIPStrategy ¶
func (c *Client) ModifyIPStrategy(request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
ModifyIPStrategy This API is used to modify a service IP policy.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) ModifyIPStrategyWithContext ¶
func (c *Client) ModifyIPStrategyWithContext(ctx context.Context, request *ModifyIPStrategyRequest) (response *ModifyIPStrategyResponse, err error)
ModifyIPStrategy This API is used to modify a service IP policy.
error code that may be returned:
INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDIPSTRATEGY = "ResourceNotFound.InvalidIPStrategy"
func (*Client) ModifyPlugin ¶
func (c *Client) ModifyPlugin(request *ModifyPluginRequest) (response *ModifyPluginResponse, err error)
ModifyPlugin This API is used to modify a plugin.
error code that may be returned:
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig" INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) ModifyPluginWithContext ¶
func (c *Client) ModifyPluginWithContext(ctx context.Context, request *ModifyPluginRequest) (response *ModifyPluginResponse, err error)
ModifyPlugin This API is used to modify a plugin.
error code that may be returned:
FAILEDOPERATION_FORMATERROR = "FailedOperation.FormatError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_VPCEXCEPTION = "InternalError.VpcException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDAPIREQUESTCONFIG = "InvalidParameterValue.InvalidApiRequestConfig" INVALIDPARAMETERVALUE_INVALIDBACKENDPATH = "InvalidParameterValue.InvalidBackendPath" INVALIDPARAMETERVALUE_INVALIDCLB = "InvalidParameterValue.InvalidClb" INVALIDPARAMETERVALUE_INVALIDIPADDRESS = "InvalidParameterValue.InvalidIPAddress" INVALIDPARAMETERVALUE_INVALIDPORT = "InvalidParameterValue.InvalidPort" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_INVALIDSCFCONFIG = "InvalidParameterValue.InvalidScfConfig" INVALIDPARAMETERVALUE_INVALIDSERVICECONFIG = "InvalidParameterValue.InvalidServiceConfig" INVALIDPARAMETERVALUE_INVALIDSERVICEPARAM = "InvalidParameterValue.InvalidServiceParam" INVALIDPARAMETERVALUE_INVALIDSERVICETYPE = "InvalidParameterValue.InvalidServiceType" INVALIDPARAMETERVALUE_INVALIDTSFCONFIG = "InvalidParameterValue.InvalidTsfConfig" INVALIDPARAMETERVALUE_INVALIDUPSTREAM = "InvalidParameterValue.InvalidUpstream" INVALIDPARAMETERVALUE_INVALIDURL = "InvalidParameterValue.InvalidUrl" INVALIDPARAMETERVALUE_LENGTHEXCEEDED = "InvalidParameterValue.LengthExceeded" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded" MISSINGPARAMETER_BACKENDSPECIFICPARAM = "MissingParameter.BackendSpecificParam" RESOURCENOTFOUND_INVALIDPLUGIN = "ResourceNotFound.InvalidPlugin" UNAUTHORIZEDOPERATION_ACCESSRESOURCE = "UnauthorizedOperation.AccessResource" UNSUPPORTEDOPERATION_INVALIDACTION = "UnsupportedOperation.InvalidAction"
func (*Client) ModifyService ¶
func (c *Client) ModifyService(request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)
ModifyService This API is used to modify the relevant information of a service. After a service is created, its name, description, and service type can be modified.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType" UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes"
func (*Client) ModifyServiceEnvironmentStrategy ¶
func (c *Client) ModifyServiceEnvironmentStrategy(request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)
ModifyServiceEnvironmentStrategy This API is used to modify a service throttling policy.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
func (*Client) ModifyServiceEnvironmentStrategyWithContext ¶
func (c *Client) ModifyServiceEnvironmentStrategyWithContext(ctx context.Context, request *ModifyServiceEnvironmentStrategyRequest) (response *ModifyServiceEnvironmentStrategyResponse, err error)
ModifyServiceEnvironmentStrategy This API is used to modify a service throttling policy.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" INVALIDPARAMETERVALUE_INVALIDREQUESTPARAMETERS = "InvalidParameterValue.InvalidRequestParameters" INVALIDPARAMETERVALUE_RANGEEXCEEDED = "InvalidParameterValue.RangeExceeded"
func (*Client) ModifyServiceWithContext ¶
func (c *Client) ModifyServiceWithContext(ctx context.Context, request *ModifyServiceRequest) (response *ModifyServiceResponse, err error)
ModifyService This API is used to modify the relevant information of a service. After a service is created, its name, description, and service type can be modified.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_NOTINOPTIONS = "InvalidParameterValue.NotInOptions" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_MODIFYNETTYPE = "UnsupportedOperation.ModifyNetType" UNSUPPORTEDOPERATION_REDUCENETTYPES = "UnsupportedOperation.ReduceNetTypes"
func (*Client) ModifySubDomain ¶
func (c *Client) ModifySubDomain(request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
ModifySubDomain This API is used to modify the path mapping in the custom domain name settings of a service. The path mapping rule can be modified before it is bound to the custom domain name.
error code that may be returned:
FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError" FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError" FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) ModifySubDomainWithContext ¶
func (c *Client) ModifySubDomainWithContext(ctx context.Context, request *ModifySubDomainRequest) (response *ModifySubDomainResponse, err error)
ModifySubDomain This API is used to modify the path mapping in the custom domain name settings of a service. The path mapping rule can be modified before it is bound to the custom domain name.
error code that may be returned:
FAILEDOPERATION_CERTIFICATEIDBINDERROR = "FailedOperation.CertificateIdBindError" FAILEDOPERATION_CERTIFICATEIDERROR = "FailedOperation.CertificateIdError" FAILEDOPERATION_PATHMAPPINGSETERROR = "FailedOperation.PathMappingSetError" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" FAILEDOPERATION_SETCUSTOMPATHMAPPINGERROR = "FailedOperation.SetCustomPathMappingError" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" FAILEDOPERATION_UNKNOWNPROTOCOLTYPEERROR = "FailedOperation.UnknownProtocolTypeError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" UNSUPPORTEDOPERATION_FORCEHTTPS = "UnsupportedOperation.ForceHttps" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) ModifyUsagePlan ¶
func (c *Client) ModifyUsagePlan(request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
ModifyUsagePlan This API is used to modify the name, description, and QPS of a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) ModifyUsagePlanWithContext ¶
func (c *Client) ModifyUsagePlanWithContext(ctx context.Context, request *ModifyUsagePlanRequest) (response *ModifyUsagePlanResponse, err error)
ModifyUsagePlan This API is used to modify the name, description, and QPS of a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) ReleaseService ¶
func (c *Client) ReleaseService(request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
ReleaseService This API is used to publish a service.
An API Gateway service can only be called when it is published to an environment and takes effect after creation. This API is used to publish a service to an environment such as the `release` environment.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ReleaseServiceWithContext ¶
func (c *Client) ReleaseServiceWithContext(ctx context.Context, request *ReleaseServiceRequest) (response *ReleaseServiceResponse, err error)
ReleaseService This API is used to publish a service.
An API Gateway service can only be called when it is published to an environment and takes effect after creation. This API is used to publish a service to an environment such as the `release` environment.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ResetAPIDocPassword ¶
func (c *Client) ResetAPIDocPassword(request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
ResetAPIDocPassword This API is used to reset the password of an API document.
error code that may be returned:
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
func (*Client) ResetAPIDocPasswordWithContext ¶
func (c *Client) ResetAPIDocPasswordWithContext(ctx context.Context, request *ResetAPIDocPasswordRequest) (response *ResetAPIDocPasswordResponse, err error)
ResetAPIDocPassword This API is used to reset the password of an API document.
error code that may be returned:
FAILEDOPERATION_CODINGERROR = "FailedOperation.CodingError" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND_INVALIDAPIDOC = "ResourceNotFound.InvalidApiDoc"
func (*Client) UnBindEnvironment ¶
func (c *Client) UnBindEnvironment(request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
UnBindEnvironment This API is used to unbind a usage plan from a specified environment.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) UnBindEnvironmentWithContext ¶
func (c *Client) UnBindEnvironmentWithContext(ctx context.Context, request *UnBindEnvironmentRequest) (response *UnBindEnvironmentResponse, err error)
UnBindEnvironment This API is used to unbind a usage plan from a specified environment.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) UnBindIPStrategy ¶
func (c *Client) UnBindIPStrategy(request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
UnBindIPStrategy This API is used to unbind an IP policy from a service.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) UnBindIPStrategyWithContext ¶
func (c *Client) UnBindIPStrategyWithContext(ctx context.Context, request *UnBindIPStrategyRequest) (response *UnBindIPStrategyResponse, err error)
UnBindIPStrategy This API is used to unbind an IP policy from a service.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan" UNSUPPORTEDOPERATION_UNSUPPORTEDUNBINDENVIRONMENT = "UnsupportedOperation.UnsupportedUnBindEnvironment"
func (*Client) UnBindSecretIds ¶
func (c *Client) UnBindSecretIds(request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
UnBindSecretIds This API is used to unbind a key from a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) UnBindSecretIdsWithContext ¶
func (c *Client) UnBindSecretIdsWithContext(ctx context.Context, request *UnBindSecretIdsRequest) (response *UnBindSecretIdsResponse, err error)
UnBindSecretIds This API is used to unbind a key from a usage plan.
error code that may be returned:
INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" RESOURCENOTFOUND_INVALIDUSAGEPLAN = "ResourceNotFound.InvalidUsagePlan"
func (*Client) UnBindSubDomain ¶
func (c *Client) UnBindSubDomain(request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
UnBindSubDomain This API is used to unbind a custom domain name.
After binding a custom domain name to a service by using API Gateway, you can use this API to unbind it.
error code that may be returned:
FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
func (*Client) UnBindSubDomainWithContext ¶
func (c *Client) UnBindSubDomainWithContext(ctx context.Context, request *UnBindSubDomainRequest) (response *UnBindSubDomainResponse, err error)
UnBindSubDomain This API is used to unbind a custom domain name.
After binding a custom domain name to a service by using API Gateway, you can use this API to unbind it.
error code that may be returned:
FAILEDOPERATION_DOMAINNOTBINDSERVICE = "FailedOperation.DomainNotBindService" FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" FAILEDOPERATION_SERVICENOTEXIST = "FailedOperation.ServiceNotExist" FAILEDOPERATION_SUBDOMAINFORMATERROR = "FailedOperation.SubDomainFormatError" UNSUPPORTEDOPERATION_INVALIDSTATUS = "UnsupportedOperation.InvalidStatus"
func (*Client) UnReleaseService ¶
func (c *Client) UnReleaseService(request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
UnReleaseService This API is used to deactivate a service.
Only after a service is published to an environment can its APIs be called. You can call this API to deactivate a service in the release environment. Once deactivated, the service cannot be called.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) UnReleaseServiceWithContext ¶
func (c *Client) UnReleaseServiceWithContext(ctx context.Context, request *UnReleaseServiceRequest) (response *UnReleaseServiceResponse, err error)
UnReleaseService This API is used to deactivate a service.
Only after a service is published to an environment can its APIs be called. You can call this API to deactivate a service in the release environment. Once deactivated, the service cannot be called.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDREGION = "InvalidParameterValue.InvalidRegion" LIMITEXCEEDED_REQUESTLIMITEXCEEDED = "LimitExceeded.RequestLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) UnbindApiApp ¶
func (c *Client) UnbindApiApp(request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)
UnbindApiApp This API is used to unbind an application from an API.
error code that may be returned:
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
func (*Client) UnbindApiAppWithContext ¶
func (c *Client) UnbindApiAppWithContext(ctx context.Context, request *UnbindApiAppRequest) (response *UnbindApiAppResponse, err error)
UnbindApiApp This API is used to unbind an application from an API.
error code that may be returned:
FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETERVALUE_INVALIDENV = "InvalidParameterValue.InvalidEnv" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_RESOURCEUNASSOCIATED = "UnsupportedOperation.ResourceUnassociated" UNSUPPORTEDOPERATION_UNSUPPORTEDBINDENVIRONMENT = "UnsupportedOperation.UnsupportedBindEnvironment"
func (*Client) UpdateApiAppKey ¶
func (c *Client) UpdateApiAppKey(request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)
UpdateApiAppKey This API is used to update an application key.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) UpdateApiAppKeyWithContext ¶
func (c *Client) UpdateApiAppKeyWithContext(ctx context.Context, request *UpdateApiAppKeyRequest) (response *UpdateApiAppKeyResponse, err error)
UpdateApiAppKey This API is used to update an application key.
error code that may be returned:
FAILEDOPERATION_APIERROR = "FailedOperation.ApiError" FAILEDOPERATION_APIINOPERATION = "FailedOperation.ApiInOperation" FAILEDOPERATION_GETROLEERROR = "FailedOperation.GetRoleError" INTERNALERROR_APIGWEXCEPTION = "InternalError.ApigwException" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INTERNALERROR_SCFEXCEPTION = "InternalError.ScfException" RESOURCENOTFOUND_INVALIDAPI = "ResourceNotFound.InvalidApi" RESOURCENOTFOUND_INVALIDAPIAPP = "ResourceNotFound.InvalidApiApp" RESOURCENOTFOUND_INVALIDSERVICE = "ResourceNotFound.InvalidService" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade" UNSUPPORTEDOPERATION_RESOURCEASSOCIATED = "UnsupportedOperation.ResourceAssociated" UNSUPPORTEDOPERATION_UNSUPPORTEDDELETEAPI = "UnsupportedOperation.UnsupportedDeleteApi"
func (*Client) UpdateApiKey ¶
func (c *Client) UpdateApiKey(request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
UpdateApiKey This API is used to update a created API key pair.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
func (*Client) UpdateApiKeyWithContext ¶
func (c *Client) UpdateApiKeyWithContext(ctx context.Context, request *UpdateApiKeyRequest) (response *UpdateApiKeyResponse, err error)
UpdateApiKey This API is used to update a created API key pair.
error code that may be returned:
RESOURCENOTFOUND_INVALIDACCESSKEYID = "ResourceNotFound.InvalidAccessKeyId" UNSUPPORTEDOPERATION_UINNOTINWHITELIST = "UnsupportedOperation.UinNotInWhiteList"
func (*Client) UpdateService ¶
func (c *Client) UpdateService(request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
UpdateService This API is used to switch the running version of a service published in an environment to a specified version. After you create a service by using API Gateway and publish it to an environment, multiple versions will be generated during development. In this case, you can call this API to switch versions.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
func (*Client) UpdateServiceWithContext ¶
func (c *Client) UpdateServiceWithContext(ctx context.Context, request *UpdateServiceRequest) (response *UpdateServiceResponse, err error)
UpdateService This API is used to switch the running version of a service published in an environment to a specified version. After you create a service by using API Gateway and publish it to an environment, multiple versions will be generated during development. In this case, you can call this API to switch versions.
error code that may be returned:
FAILEDOPERATION_SERVICEERROR = "FailedOperation.ServiceError" FAILEDOPERATION_SERVICEINOPERATION = "FailedOperation.ServiceInOperation" INTERNALERROR_OSSEXCEPTION = "InternalError.OssException" INVALIDPARAMETER_FORMATERROR = "InvalidParameter.FormatError" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_INVALIDSERVICETRADE = "UnsupportedOperation.InvalidServiceTrade"
type ConstantParameter ¶
type ConstantParameter struct { // Constant parameter name, which is used only if `ServiceType` is `HTTP`. Name *string `json:"Name,omitempty" name:"Name"` // Constant parameter description, which is used only if `ServiceType` is `HTTP`. Desc *string `json:"Desc,omitempty" name:"Desc"` // Constant parameter position, which is used only if `ServiceType` is `HTTP`. Position *string `json:"Position,omitempty" name:"Position"` // Default value of constant parameter, which is used only if `ServiceType` is `HTTP`. DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"` }
type CreateAPIDocRequest ¶
type CreateAPIDocRequest struct { *tchttp.BaseRequest // API document name ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"` // Service name ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment name Environment *string `json:"Environment,omitempty" name:"Environment"` // List of APIs for which to generate documents ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewCreateAPIDocRequest ¶
func NewCreateAPIDocRequest() (request *CreateAPIDocRequest)
func (*CreateAPIDocRequest) FromJsonString ¶
func (r *CreateAPIDocRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateAPIDocRequest) ToJsonString ¶
func (r *CreateAPIDocRequest) ToJsonString() string
type CreateAPIDocResponse ¶
type CreateAPIDocResponse struct { *tchttp.BaseResponse Response *struct { // Basic information of API document Result *APIDoc `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateAPIDocResponse) ToJsonString ¶
func (r *CreateAPIDocResponse) ToJsonString() string
type CreateApiAppRequest ¶
type CreateApiAppRequest struct { *tchttp.BaseRequest // Custom application name. ApiAppName *string `json:"ApiAppName,omitempty" name:"ApiAppName"` // Application description ApiAppDesc *string `json:"ApiAppDesc,omitempty" name:"ApiAppDesc"` }
func NewCreateApiAppRequest ¶
func NewCreateApiAppRequest() (request *CreateApiAppRequest)
func (*CreateApiAppRequest) FromJsonString ¶
func (r *CreateApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiAppRequest) ToJsonString ¶
func (r *CreateApiAppRequest) ToJsonString() string
type CreateApiAppResponse ¶
type CreateApiAppResponse struct { *tchttp.BaseResponse Response *struct { // New application details. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiAppInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateApiAppResponse ¶
func NewCreateApiAppResponse() (response *CreateApiAppResponse)
func (*CreateApiAppResponse) FromJsonString ¶
func (r *CreateApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiAppResponse) ToJsonString ¶
func (r *CreateApiAppResponse) ToJsonString() string
type CreateApiKeyRequest ¶
type CreateApiKeyRequest struct { *tchttp.BaseRequest // Custom key name. SecretName *string `json:"SecretName,omitempty" name:"SecretName"` // Key type. Valid values: auto, manual (custom key). Default value: auto. AccessKeyType *string `json:"AccessKeyType,omitempty" name:"AccessKeyType"` // Custom key ID, which is required if `AccessKeyType` is `manual`. It can contain 5–50 letters, digits, and underscores. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` // Custom key, which is required if `AccessKeyType` is `manual`. It can contain 10–50 letters, digits, and underscores. AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"` }
func NewCreateApiKeyRequest ¶
func NewCreateApiKeyRequest() (request *CreateApiKeyRequest)
func (*CreateApiKeyRequest) FromJsonString ¶
func (r *CreateApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiKeyRequest) ToJsonString ¶
func (r *CreateApiKeyRequest) ToJsonString() string
type CreateApiKeyResponse ¶
type CreateApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // New key details. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiKey `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiKeyResponse) ToJsonString ¶
func (r *CreateApiKeyResponse) ToJsonString() string
type CreateApiRequest ¶
type CreateApiRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // API backend service type. Valid values: HTTP, MOCK, TSF, SCF, WEBSOCKET, TARGET (in beta test). ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"` // API backend service timeout period in seconds. ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"` // API frontend request protocol. Valid values: HTTPS, WEBSOCKET. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Request frontend configuration. RequestConfig *ApiRequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"` // Custom API name. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // Custom API description. ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"` // API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL. ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH, APP (application authentication). Default value: NONE. AuthType *string `json:"AuthType,omitempty" name:"AuthType"` // Whether to enable CORS. EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"` // Constant parameter. ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters"` // Frontend request parameter. RequestParameters []*RequestParameter `json:"RequestParameters,omitempty" name:"RequestParameters"` // This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API. ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"` // Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"` // List of microservices bound to API. MicroServices []*MicroServiceReq `json:"MicroServices,omitempty" name:"MicroServices"` // Load balancing configuration of microservice. ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"` // Health check configuration of microservice. ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"` // `target` type backend resource information (in beta test). TargetServices []*TargetServicesReq `json:"TargetServices,omitempty" name:"TargetServices"` // `target` type load balancing configuration (in beta test). TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitempty" name:"TargetServicesLoadBalanceConf"` // `target` health check configuration (in beta test). TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitempty" name:"TargetServicesHealthCheckConf"` // SCF function name, which takes effect if the backend type is `SCF`. ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"` // SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"` // SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"` // SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"` // SCF function namespace, which takes effect if the backend type is `SCF`. ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"` // SCF function version, which takes effect if the backend type is `SCF`. ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"` // SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"` // SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"` // SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"` // SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"` // Whether to enable response integration, which takes effect if the backend type is `SCF`. ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"` // Billing after debugging starts (reserved field for marketplace). IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"` // Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted. IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitempty" name:"IsDeleteResponseErrorCodes"` // Return type. ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"` // Sample response for successful custom response configuration. ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"` // Sample response for failed custom response configuration. ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"` // API backend service configuration. ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"` // Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"` // API backend service parameter. ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters"` // OAuth configuration, which takes effect if `AuthType` is `OAUTH`. OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"` // Custom error code configuration. ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes"` // TSF Serverless namespace ID (in beta test). TargetNamespaceId *string `json:"TargetNamespaceId,omitempty" name:"TargetNamespaceId"` // User type. UserType *string `json:"UserType,omitempty" name:"UserType"` // Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"` // SCF function type, which takes effect if the backend type is `SCF`. Valid values: `EVENT` and `HTTP`. ServiceScfFunctionType *string `json:"ServiceScfFunctionType,omitempty" name:"ServiceScfFunctionType"` // EIAM application type. EIAMAppType *string `json:"EIAMAppType,omitempty" name:"EIAMAppType"` // EIAM application authentication type. Valid values: `AuthenticationOnly`, `Authentication`, `Authorization`. EIAMAuthType *string `json:"EIAMAuthType,omitempty" name:"EIAMAuthType"` // Validity of the EIAM application token. Unit: second. Default value: `7200`. TokenTimeout *int64 `json:"TokenTimeout,omitempty" name:"TokenTimeout"` // EIAM application ID. EIAMAppId *string `json:"EIAMAppId,omitempty" name:"EIAMAppId"` }
func NewCreateApiRequest ¶
func NewCreateApiRequest() (request *CreateApiRequest)
func (*CreateApiRequest) FromJsonString ¶
func (r *CreateApiRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiRequest) ToJsonString ¶
func (r *CreateApiRequest) ToJsonString() string
type CreateApiResponse ¶
type CreateApiResponse struct { *tchttp.BaseResponse Response *struct { // API information // Note: this field may return null, indicating that no valid values can be obtained. Result *CreateApiRsp `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiResponse) ToJsonString ¶
func (r *CreateApiResponse) ToJsonString() string
type CreateApiRsp ¶
type CreateApiRsp struct { // API ID // Note: this field may return null, indicating that no valid values can be obtained. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // path // Note: this field may return null, indicating that no valid values can be obtained. Path *string `json:"Path,omitempty" name:"Path"` // method // Note: this field may return null, indicating that no valid values can be obtained. Method *string `json:"Method,omitempty" name:"Method"` // Creation time // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` }
type CreateIPStrategyRequest ¶
type CreateIPStrategyRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom policy name. StrategyName *string `json:"StrategyName,omitempty" name:"StrategyName"` // Policy type. Valid values: WHITE (allowlist), BLACK (blocklist). StrategyType *string `json:"StrategyType,omitempty" name:"StrategyType"` // Policy details. Multiple IPs are separated with \n. StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"` }
func NewCreateIPStrategyRequest ¶
func NewCreateIPStrategyRequest() (request *CreateIPStrategyRequest)
func (*CreateIPStrategyRequest) FromJsonString ¶
func (r *CreateIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateIPStrategyRequest) ToJsonString ¶
func (r *CreateIPStrategyRequest) ToJsonString() string
type CreateIPStrategyResponse ¶
type CreateIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // New IP policy details. // Note: this field may return null, indicating that no valid values can be obtained. Result *IPStrategy `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateIPStrategyResponse) ToJsonString ¶
func (r *CreateIPStrategyResponse) ToJsonString() string
type CreatePluginRequest ¶
type CreatePluginRequest struct { *tchttp.BaseRequest // Custom plugin name. A plugin name should contain 2-50 characters out of a-z, A-Z, 0-9, and _, which must begin with a letter and end with a letter or a number. PluginName *string `json:"PluginName,omitempty" name:"PluginName"` // Plugin type. Valid values: `IPControl`, `TrafficControl`, `Cors`, `CustomReq`, `CustomAuth`, `Routing`, `TrafficControlByParameter`. PluginType *string `json:"PluginType,omitempty" name:"PluginType"` // Plugin definition statement in json format PluginData *string `json:"PluginData,omitempty" name:"PluginData"` // Plugin description within 200 characters Description *string `json:"Description,omitempty" name:"Description"` }
func NewCreatePluginRequest ¶
func NewCreatePluginRequest() (request *CreatePluginRequest)
func (*CreatePluginRequest) FromJsonString ¶
func (r *CreatePluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreatePluginRequest) ToJsonString ¶
func (r *CreatePluginRequest) ToJsonString() string
type CreatePluginResponse ¶
type CreatePluginResponse struct { *tchttp.BaseResponse Response *struct { // Details of the new plugin Result *Plugin `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreatePluginResponse ¶
func NewCreatePluginResponse() (response *CreatePluginResponse)
func (*CreatePluginResponse) FromJsonString ¶
func (r *CreatePluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreatePluginResponse) ToJsonString ¶
func (r *CreatePluginResponse) ToJsonString() string
type CreateServiceRequest ¶
type CreateServiceRequest struct { *tchttp.BaseRequest // Custom service name. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Service frontend request type, such as `http`, `https`, and `http&https`. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Custom service description. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Dedicated cluster name, which is used to specify the dedicated cluster where the service is to be created. ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"` // Network type list, which is used to specify the supported network types. INNER: private network access; OUTER: public network access. Default value: OUTER. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` // IP version number. Valid values: IPv4, IPv6. Default value: IPv4. IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"` // Cluster name, which is reserved and used by the `tsf serverless` type. SetServerName *string `json:"SetServerName,omitempty" name:"SetServerName"` // User type, which is reserved and can be used by `serverless` users. AppIdType *string `json:"AppIdType,omitempty" name:"AppIdType"` // Tag information. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Dedicated instance ID InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` }
func NewCreateServiceRequest ¶
func NewCreateServiceRequest() (request *CreateServiceRequest)
func (*CreateServiceRequest) FromJsonString ¶
func (r *CreateServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateServiceRequest) ToJsonString ¶
func (r *CreateServiceRequest) ToJsonString() string
type CreateServiceResponse ¶
type CreateServiceResponse struct { *tchttp.BaseResponse Response *struct { // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom service name. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Custom service description. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Default public domain name. OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"` // Default VPC domain name. InnerSubDomain *string `json:"InnerSubDomain,omitempty" name:"InnerSubDomain"` // Service creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Network type list. INNER: private network access; OUTER: public network access. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` // IP version number. // Note: this field may return null, indicating that no valid values can be obtained. IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateServiceResponse) ToJsonString ¶
func (r *CreateServiceResponse) ToJsonString() string
type CreateUsagePlanRequest ¶
type CreateUsagePlanRequest struct { *tchttp.BaseRequest // Custom usage plan name. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Custom usage plan description. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is `-1`, which indicates no limit. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Limit of requests per second. Valid values: -1, [1,2000]. The default value is `-1`, which indicates no limit. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` }
func NewCreateUsagePlanRequest ¶
func NewCreateUsagePlanRequest() (request *CreateUsagePlanRequest)
func (*CreateUsagePlanRequest) FromJsonString ¶
func (r *CreateUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateUsagePlanRequest) ToJsonString ¶
func (r *CreateUsagePlanRequest) ToJsonString() string
type CreateUsagePlanResponse ¶
type CreateUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // Usage plan details. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateUsagePlanResponse) ToJsonString ¶
func (r *CreateUsagePlanResponse) ToJsonString() string
type DeleteAPIDocRequest ¶
type DeleteAPIDocRequest struct { *tchttp.BaseRequest // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` }
func NewDeleteAPIDocRequest ¶
func NewDeleteAPIDocRequest() (request *DeleteAPIDocRequest)
func (*DeleteAPIDocRequest) FromJsonString ¶
func (r *DeleteAPIDocRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteAPIDocRequest) ToJsonString ¶
func (r *DeleteAPIDocRequest) ToJsonString() string
type DeleteAPIDocResponse ¶
type DeleteAPIDocResponse struct { *tchttp.BaseResponse Response *struct { // Whether the operation succeeded Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteAPIDocResponse) ToJsonString ¶
func (r *DeleteAPIDocResponse) ToJsonString() string
type DeleteApiAppRequest ¶
type DeleteApiAppRequest struct { *tchttp.BaseRequest // Unique application ID. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` }
func NewDeleteApiAppRequest ¶
func NewDeleteApiAppRequest() (request *DeleteApiAppRequest)
func (*DeleteApiAppRequest) FromJsonString ¶
func (r *DeleteApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiAppRequest) ToJsonString ¶
func (r *DeleteApiAppRequest) ToJsonString() string
type DeleteApiAppResponse ¶
type DeleteApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteApiAppResponse ¶
func NewDeleteApiAppResponse() (response *DeleteApiAppResponse)
func (*DeleteApiAppResponse) FromJsonString ¶
func (r *DeleteApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiAppResponse) ToJsonString ¶
func (r *DeleteApiAppResponse) ToJsonString() string
type DeleteApiKeyRequest ¶
type DeleteApiKeyRequest struct { *tchttp.BaseRequest // ID of the key to be deleted. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` }
func NewDeleteApiKeyRequest ¶
func NewDeleteApiKeyRequest() (request *DeleteApiKeyRequest)
func (*DeleteApiKeyRequest) FromJsonString ¶
func (r *DeleteApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiKeyRequest) ToJsonString ¶
func (r *DeleteApiKeyRequest) ToJsonString() string
type DeleteApiKeyResponse ¶
type DeleteApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiKeyResponse) ToJsonString ¶
func (r *DeleteApiKeyResponse) ToJsonString() string
type DeleteApiRequest ¶
type DeleteApiRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiRequest) ToJsonString ¶
func (r *DeleteApiRequest) ToJsonString() string
type DeleteApiResponse ¶
type DeleteApiResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteApiResponse) ToJsonString ¶
func (r *DeleteApiResponse) ToJsonString() string
type DeleteIPStrategyRequest ¶
type DeleteIPStrategyRequest struct { *tchttp.BaseRequest // Unique service ID of the IP policy to be deleted. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the IP policy to be deleted. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` }
func NewDeleteIPStrategyRequest ¶
func NewDeleteIPStrategyRequest() (request *DeleteIPStrategyRequest)
func (*DeleteIPStrategyRequest) FromJsonString ¶
func (r *DeleteIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteIPStrategyRequest) ToJsonString ¶
func (r *DeleteIPStrategyRequest) ToJsonString() string
type DeleteIPStrategyResponse ¶
type DeleteIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteIPStrategyResponse) ToJsonString ¶
func (r *DeleteIPStrategyResponse) ToJsonString() string
type DeletePluginRequest ¶
type DeletePluginRequest struct { *tchttp.BaseRequest // ID of the plugin to be deleted PluginId *string `json:"PluginId,omitempty" name:"PluginId"` }
func NewDeletePluginRequest ¶
func NewDeletePluginRequest() (request *DeletePluginRequest)
func (*DeletePluginRequest) FromJsonString ¶
func (r *DeletePluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePluginRequest) ToJsonString ¶
func (r *DeletePluginRequest) ToJsonString() string
type DeletePluginResponse ¶
type DeletePluginResponse struct { *tchttp.BaseResponse Response *struct { // Result of the deletion action Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeletePluginResponse ¶
func NewDeletePluginResponse() (response *DeletePluginResponse)
func (*DeletePluginResponse) FromJsonString ¶
func (r *DeletePluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeletePluginResponse) ToJsonString ¶
func (r *DeletePluginResponse) ToJsonString() string
type DeleteServiceRequest ¶
type DeleteServiceRequest struct { *tchttp.BaseRequest // Unique ID of the service to be deleted. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // A parameter used to set to skip the deletion precondition verification (only supported for services on dedicated instances). SkipVerification *int64 `json:"SkipVerification,omitempty" name:"SkipVerification"` }
func NewDeleteServiceRequest ¶
func NewDeleteServiceRequest() (request *DeleteServiceRequest)
func (*DeleteServiceRequest) FromJsonString ¶
func (r *DeleteServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteServiceRequest) ToJsonString ¶
func (r *DeleteServiceRequest) ToJsonString() string
type DeleteServiceResponse ¶
type DeleteServiceResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteServiceResponse) ToJsonString ¶
func (r *DeleteServiceResponse) ToJsonString() string
type DeleteServiceSubDomainMappingRequest ¶
type DeleteServiceSubDomainMappingRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom domain name bound to service. SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"` // Name of the environment whose mapping is to be deleted. Valid values: test (test environment), prepub (pre-release environment), release (release environment). Environment *string `json:"Environment,omitempty" name:"Environment"` }
func NewDeleteServiceSubDomainMappingRequest ¶
func NewDeleteServiceSubDomainMappingRequest() (request *DeleteServiceSubDomainMappingRequest)
func (*DeleteServiceSubDomainMappingRequest) FromJsonString ¶
func (r *DeleteServiceSubDomainMappingRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteServiceSubDomainMappingRequest) ToJsonString ¶
func (r *DeleteServiceSubDomainMappingRequest) ToJsonString() string
type DeleteServiceSubDomainMappingResponse ¶
type DeleteServiceSubDomainMappingResponse struct { *tchttp.BaseResponse Response *struct { // Whether the path mapping of the custom domain name is successfully deleted. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique ID of the usage plan to be deleted. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` }
func NewDeleteUsagePlanRequest ¶
func NewDeleteUsagePlanRequest() (request *DeleteUsagePlanRequest)
func (*DeleteUsagePlanRequest) FromJsonString ¶
func (r *DeleteUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteUsagePlanRequest) ToJsonString ¶
func (r *DeleteUsagePlanRequest) ToJsonString() string
type DeleteUsagePlanResponse ¶
type DeleteUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // Whether deletion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteUsagePlanResponse) ToJsonString ¶
func (r *DeleteUsagePlanResponse) ToJsonString() string
type DemoteServiceUsagePlanRequest ¶
type DemoteServiceUsagePlanRequest struct { *tchttp.BaseRequest // Usage plan ID. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Unique ID of the service to be demoted. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment name. Environment *string `json:"Environment,omitempty" name:"Environment"` }
func NewDemoteServiceUsagePlanRequest ¶
func NewDemoteServiceUsagePlanRequest() (request *DemoteServiceUsagePlanRequest)
func (*DemoteServiceUsagePlanRequest) FromJsonString ¶
func (r *DemoteServiceUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DemoteServiceUsagePlanRequest) ToJsonString ¶
func (r *DemoteServiceUsagePlanRequest) ToJsonString() string
type DemoteServiceUsagePlanResponse ¶
type DemoteServiceUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // Whether demotion succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DemoteServiceUsagePlanResponse) ToJsonString ¶
func (r *DemoteServiceUsagePlanResponse) ToJsonString() string
type DesApisStatus ¶
type DesApisStatus struct { // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Custom API description. // Note: this field may return null, indicating that no valid values can be obtained. ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // API name. // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // VPC ID. // Note: this field may return null, indicating that no valid values can be obtained. VpcId *int64 `json:"VpcId,omitempty" name:"VpcId"` // Unique VPC ID. // Note: this field may return null, indicating that no valid values can be obtained. UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"` // API type. Valid values: NORMAL (general API), TSF (microservice API). // Note: this field may return null, indicating that no valid values can be obtained. ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API protocol. // Note: this field may return null, indicating that no valid values can be obtained. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Whether to enable debugging after purchase (reserved field for the marketplace) // Note: this field may return null, indicating that no valid values can be obtained. IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"` // API authentication type. Valid values: `SECRET` (key pair authentication), `NONE` (no authentication), `OAUTH`, and `EIAM` // Note: this field may return `null`, indicating that no valid values can be obtained. AuthType *string `json:"AuthType,omitempty" name:"AuthType"` // OAuth API type, which is valid if `AuthType` is `OAUTH`. Valid values: NORMAL (business API), OAUTH (authorization API). // Note: this field may return null, indicating that no valid values can be obtained. ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"` // Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. // Note: this field may return null, indicating that no valid values can be obtained. AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"` // OAuth configuration information, which takes effect if `AuthType` is `OAUTH`. // Note: this field may return null, indicating that no valid values can be obtained. OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"` // List of business APIs associated with authorization API. // Note: this field may return null, indicating that no valid values can be obtained. RelationBuniessApiIds []*string `json:"RelationBuniessApiIds,omitempty" name:"RelationBuniessApiIds"` // Information of tags associated with API. // Note: this field may return null, indicating that no valid values can be obtained. Tags []*string `json:"Tags,omitempty" name:"Tags"` // API path, such as `/path`. // Note: this field may return null, indicating that no valid values can be obtained. Path *string `json:"Path,omitempty" name:"Path"` // API request method, such as `GET`. // Note: this field may return null, indicating that no valid values can be obtained. Method *string `json:"Method,omitempty" name:"Method"` }
type DescribeAPIDocDetailRequest ¶
type DescribeAPIDocDetailRequest struct { *tchttp.BaseRequest // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` }
func NewDescribeAPIDocDetailRequest ¶
func NewDescribeAPIDocDetailRequest() (request *DescribeAPIDocDetailRequest)
func (*DescribeAPIDocDetailRequest) FromJsonString ¶
func (r *DescribeAPIDocDetailRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAPIDocDetailRequest) ToJsonString ¶
func (r *DescribeAPIDocDetailRequest) ToJsonString() string
type DescribeAPIDocDetailResponse ¶
type DescribeAPIDocDetailResponse struct { *tchttp.BaseResponse Response *struct { // API document details Result *APIDocInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAPIDocDetailResponse) ToJsonString ¶
func (r *DescribeAPIDocDetailResponse) ToJsonString() string
type DescribeAPIDocsRequest ¶
type DescribeAPIDocsRequest struct { *tchttp.BaseRequest // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeAPIDocsRequest ¶
func NewDescribeAPIDocsRequest() (request *DescribeAPIDocsRequest)
func (*DescribeAPIDocsRequest) FromJsonString ¶
func (r *DescribeAPIDocsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAPIDocsRequest) ToJsonString ¶
func (r *DescribeAPIDocsRequest) ToJsonString() string
type DescribeAPIDocsResponse ¶
type DescribeAPIDocsResponse struct { *tchttp.BaseResponse Response *struct { // API document list information Result *APIDocs `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAPIDocsResponse) ToJsonString ¶
func (r *DescribeAPIDocsResponse) ToJsonString() string
type DescribeAllPluginApisRequest ¶
type DescribeAllPluginApisRequest struct { *tchttp.BaseRequest // ID of the service to be queried ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // ID of the plugin to be queried PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Environment information EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Number of returned results. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeAllPluginApisRequest ¶
func NewDescribeAllPluginApisRequest() (request *DescribeAllPluginApisRequest)
func (*DescribeAllPluginApisRequest) FromJsonString ¶
func (r *DescribeAllPluginApisRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAllPluginApisRequest) ToJsonString ¶
func (r *DescribeAllPluginApisRequest) ToJsonString() string
type DescribeAllPluginApisResponse ¶
type DescribeAllPluginApisResponse struct { *tchttp.BaseResponse Response *struct { // List of APIs that ca use this plugin Result *ApiInfoSummary `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeAllPluginApisResponse ¶
func NewDescribeAllPluginApisResponse() (response *DescribeAllPluginApisResponse)
func (*DescribeAllPluginApisResponse) FromJsonString ¶
func (r *DescribeAllPluginApisResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAllPluginApisResponse) ToJsonString ¶
func (r *DescribeAllPluginApisResponse) ToJsonString() string
type DescribeApiAppBindApisStatusRequest ¶
type DescribeApiAppBindApisStatusRequest struct { *tchttp.BaseRequest // Application ID ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Number of returned results. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: ApiId, ApiName, ServiceId, Environment, KeyWord (match with `name` or ID). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeApiAppBindApisStatusRequest ¶
func NewDescribeApiAppBindApisStatusRequest() (request *DescribeApiAppBindApisStatusRequest)
func (*DescribeApiAppBindApisStatusRequest) FromJsonString ¶
func (r *DescribeApiAppBindApisStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppBindApisStatusRequest) ToJsonString ¶
func (r *DescribeApiAppBindApisStatusRequest) ToJsonString() string
type DescribeApiAppBindApisStatusResponse ¶
type DescribeApiAppBindApisStatusResponse struct { *tchttp.BaseResponse Response *struct { // List of APIs bound to the application. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiAppApiInfos `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeApiAppBindApisStatusResponse ¶
func NewDescribeApiAppBindApisStatusResponse() (response *DescribeApiAppBindApisStatusResponse)
func (*DescribeApiAppBindApisStatusResponse) FromJsonString ¶
func (r *DescribeApiAppBindApisStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppBindApisStatusResponse) ToJsonString ¶
func (r *DescribeApiAppBindApisStatusResponse) ToJsonString() string
type DescribeApiAppRequest ¶
type DescribeApiAppRequest struct { *tchttp.BaseRequest // Application ID. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` }
func NewDescribeApiAppRequest ¶
func NewDescribeApiAppRequest() (request *DescribeApiAppRequest)
func (*DescribeApiAppRequest) FromJsonString ¶
func (r *DescribeApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppRequest) ToJsonString ¶
func (r *DescribeApiAppRequest) ToJsonString() string
type DescribeApiAppResponse ¶
type DescribeApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Application details. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiAppInfos `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeApiAppResponse ¶
func NewDescribeApiAppResponse() (response *DescribeApiAppResponse)
func (*DescribeApiAppResponse) FromJsonString ¶
func (r *DescribeApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppResponse) ToJsonString ¶
func (r *DescribeApiAppResponse) ToJsonString() string
type DescribeApiAppsStatusRequest ¶
type DescribeApiAppsStatusRequest struct { *tchttp.BaseRequest // Number of returned results. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: ApiAppId, ApiAppName, KeyWord (match with `name` or ID). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeApiAppsStatusRequest ¶
func NewDescribeApiAppsStatusRequest() (request *DescribeApiAppsStatusRequest)
func (*DescribeApiAppsStatusRequest) FromJsonString ¶
func (r *DescribeApiAppsStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppsStatusRequest) ToJsonString ¶
func (r *DescribeApiAppsStatusRequest) ToJsonString() string
type DescribeApiAppsStatusResponse ¶
type DescribeApiAppsStatusResponse struct { *tchttp.BaseResponse Response *struct { // Application list. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiAppInfos `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeApiAppsStatusResponse ¶
func NewDescribeApiAppsStatusResponse() (response *DescribeApiAppsStatusResponse)
func (*DescribeApiAppsStatusResponse) FromJsonString ¶
func (r *DescribeApiAppsStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiAppsStatusResponse) ToJsonString ¶
func (r *DescribeApiAppsStatusResponse) ToJsonString() string
type DescribeApiBindApiAppsStatusRequest ¶
type DescribeApiBindApiAppsStatusRequest struct { *tchttp.BaseRequest // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Array of API IDs ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` // Number of returned results. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: ApiAppId, Environment, KeyWord (match with `name` or ID). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeApiBindApiAppsStatusRequest ¶
func NewDescribeApiBindApiAppsStatusRequest() (request *DescribeApiBindApiAppsStatusRequest)
func (*DescribeApiBindApiAppsStatusRequest) FromJsonString ¶
func (r *DescribeApiBindApiAppsStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiBindApiAppsStatusRequest) ToJsonString ¶
func (r *DescribeApiBindApiAppsStatusRequest) ToJsonString() string
type DescribeApiBindApiAppsStatusResponse ¶
type DescribeApiBindApiAppsStatusResponse struct { *tchttp.BaseResponse Response *struct { // List of APIs bound to the application. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiAppApiInfos `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeApiBindApiAppsStatusResponse ¶
func NewDescribeApiBindApiAppsStatusResponse() (response *DescribeApiBindApiAppsStatusResponse)
func (*DescribeApiBindApiAppsStatusResponse) FromJsonString ¶
func (r *DescribeApiBindApiAppsStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiBindApiAppsStatusResponse) ToJsonString ¶
func (r *DescribeApiBindApiAppsStatusResponse) ToJsonString() string
type DescribeApiEnvironmentStrategyRequest ¶
type DescribeApiEnvironmentStrategyRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment list. EnvironmentNames []*string `json:"EnvironmentNames,omitempty" name:"EnvironmentNames"` // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeApiEnvironmentStrategyRequest ¶
func NewDescribeApiEnvironmentStrategyRequest() (request *DescribeApiEnvironmentStrategyRequest)
func (*DescribeApiEnvironmentStrategyRequest) FromJsonString ¶
func (r *DescribeApiEnvironmentStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiEnvironmentStrategyRequest) ToJsonString ¶
func (r *DescribeApiEnvironmentStrategyRequest) ToJsonString() string
type DescribeApiEnvironmentStrategyResponse ¶
type DescribeApiEnvironmentStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Details of policies bound to API // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiEnvironmentStrategyStataus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 DescribeApiForApiAppRequest ¶
type DescribeApiForApiAppRequest struct { *tchttp.BaseRequest // Unique service ID of the API ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API region ApiRegion *string `json:"ApiRegion,omitempty" name:"ApiRegion"` }
func NewDescribeApiForApiAppRequest ¶
func NewDescribeApiForApiAppRequest() (request *DescribeApiForApiAppRequest)
func (*DescribeApiForApiAppRequest) FromJsonString ¶
func (r *DescribeApiForApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiForApiAppRequest) ToJsonString ¶
func (r *DescribeApiForApiAppRequest) ToJsonString() string
type DescribeApiForApiAppResponse ¶
type DescribeApiForApiAppResponse struct { *tchttp.BaseResponse Response *struct { // API details. Result *ApiInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeApiForApiAppResponse ¶
func NewDescribeApiForApiAppResponse() (response *DescribeApiForApiAppResponse)
func (*DescribeApiForApiAppResponse) FromJsonString ¶
func (r *DescribeApiForApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiForApiAppResponse) ToJsonString ¶
func (r *DescribeApiForApiAppResponse) ToJsonString() string
type DescribeApiKeyRequest ¶
type DescribeApiKeyRequest struct { *tchttp.BaseRequest // API key ID. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` }
func NewDescribeApiKeyRequest ¶
func NewDescribeApiKeyRequest() (request *DescribeApiKeyRequest)
func (*DescribeApiKeyRequest) FromJsonString ¶
func (r *DescribeApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiKeyRequest) ToJsonString ¶
func (r *DescribeApiKeyRequest) ToJsonString() string
type DescribeApiKeyResponse ¶
type DescribeApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // Key details. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiKey `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiKeyResponse) ToJsonString ¶
func (r *DescribeApiKeyResponse) ToJsonString() string
type DescribeApiKeysStatusRequest ¶
type DescribeApiKeysStatusRequest struct { *tchttp.BaseRequest // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: AccessKeyId, AccessKeySecret, SecretName, NotUsagePlanId, Status, KeyWord (match with `name` or `path`). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeApiKeysStatusRequest ¶
func NewDescribeApiKeysStatusRequest() (request *DescribeApiKeysStatusRequest)
func (*DescribeApiKeysStatusRequest) FromJsonString ¶
func (r *DescribeApiKeysStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiKeysStatusRequest) ToJsonString ¶
func (r *DescribeApiKeysStatusRequest) ToJsonString() string
type DescribeApiKeysStatusResponse ¶
type DescribeApiKeysStatusResponse struct { *tchttp.BaseResponse Response *struct { // Key list. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiKeysStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiKeysStatusResponse) ToJsonString ¶
func (r *DescribeApiKeysStatusResponse) ToJsonString() string
type DescribeApiRequest ¶
type DescribeApiRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiRequest) ToJsonString ¶
func (r *DescribeApiRequest) ToJsonString() string
type DescribeApiResponse ¶
type DescribeApiResponse struct { *tchttp.BaseResponse Response *struct { // API details. Result *ApiInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiResponse) ToJsonString ¶
func (r *DescribeApiResponse) ToJsonString() string
type DescribeApiUsagePlanRequest ¶
type DescribeApiUsagePlanRequest struct { *tchttp.BaseRequest // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeApiUsagePlanRequest ¶
func NewDescribeApiUsagePlanRequest() (request *DescribeApiUsagePlanRequest)
func (*DescribeApiUsagePlanRequest) FromJsonString ¶
func (r *DescribeApiUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiUsagePlanRequest) ToJsonString ¶
func (r *DescribeApiUsagePlanRequest) ToJsonString() string
type DescribeApiUsagePlanResponse ¶
type DescribeApiUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // List of usage plans bound to API. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiUsagePlanSet `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApiUsagePlanResponse) ToJsonString ¶
func (r *DescribeApiUsagePlanResponse) ToJsonString() string
type DescribeApisStatusRequest ¶
type DescribeApisStatusRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Number of returned results. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // API filter. Valid values: ApiId, ApiName, ApiPath, ApiType, AuthRelationApiId, AuthType, ApiBuniessType, NotUsagePlanId, Environment, Tags (whose values are the list of `$tag_key:tag_value`), TagKeys (whose values are the list of tag keys). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeApisStatusRequest ¶
func NewDescribeApisStatusRequest() (request *DescribeApisStatusRequest)
func (*DescribeApisStatusRequest) FromJsonString ¶
func (r *DescribeApisStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApisStatusRequest) ToJsonString ¶
func (r *DescribeApisStatusRequest) ToJsonString() string
type DescribeApisStatusResponse ¶
type DescribeApisStatusResponse struct { *tchttp.BaseResponse Response *struct { // List of API details. Result *ApisStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApisStatusResponse) ToJsonString ¶
func (r *DescribeApisStatusResponse) ToJsonString() string
type DescribeIPStrategyApisStatusRequest ¶
type DescribeIPStrategyApisStatusRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique policy ID. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Policy environment. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: ApiPath, ApiName, KeyWord (fuzzy search by `Path` and `Name`). Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeIPStrategyApisStatusRequest ¶
func NewDescribeIPStrategyApisStatusRequest() (request *DescribeIPStrategyApisStatusRequest)
func (*DescribeIPStrategyApisStatusRequest) FromJsonString ¶
func (r *DescribeIPStrategyApisStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategyApisStatusRequest) ToJsonString ¶
func (r *DescribeIPStrategyApisStatusRequest) ToJsonString() string
type DescribeIPStrategyApisStatusResponse ¶
type DescribeIPStrategyApisStatusResponse struct { *tchttp.BaseResponse Response *struct { // List of APIs bound to environment. // Note: this field may return null, indicating that no valid values can be obtained. Result *IPStrategyApiStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategyApisStatusResponse) ToJsonString ¶
func (r *DescribeIPStrategyApisStatusResponse) ToJsonString() string
type DescribeIPStrategyRequest ¶
type DescribeIPStrategyRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique IP policy ID. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Environment associated with policy. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter, which is a reserved field. Filtering is not supported currently. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeIPStrategyRequest ¶
func NewDescribeIPStrategyRequest() (request *DescribeIPStrategyRequest)
func (*DescribeIPStrategyRequest) FromJsonString ¶
func (r *DescribeIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategyRequest) ToJsonString ¶
func (r *DescribeIPStrategyRequest) ToJsonString() string
type DescribeIPStrategyResponse ¶
type DescribeIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // IP policy details. // Note: this field may return null, indicating that no valid values can be obtained. Result *IPStrategy `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategyResponse) ToJsonString ¶
func (r *DescribeIPStrategyResponse) ToJsonString() string
type DescribeIPStrategysStatusRequest ¶
type DescribeIPStrategysStatusRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Filter. Valid values: StrategyName. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeIPStrategysStatusRequest ¶
func NewDescribeIPStrategysStatusRequest() (request *DescribeIPStrategysStatusRequest)
func (*DescribeIPStrategysStatusRequest) FromJsonString ¶
func (r *DescribeIPStrategysStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategysStatusRequest) ToJsonString ¶
func (r *DescribeIPStrategysStatusRequest) ToJsonString() string
type DescribeIPStrategysStatusResponse ¶
type DescribeIPStrategysStatusResponse struct { *tchttp.BaseResponse Response *struct { // List of eligible policies. // Note: this field may return null, indicating that no valid values can be obtained. Result *IPStrategysStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeIPStrategysStatusResponse) ToJsonString ¶
func (r *DescribeIPStrategysStatusResponse) ToJsonString() string
type DescribeLogSearchRequest ¶
type DescribeLogSearchRequest struct { *tchttp.BaseRequest // Log start time StartTime *string `json:"StartTime,omitempty" name:"StartTime"` // Log end time EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Reserved field Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Number of logs to be returned at a time. Maximum value: 100 Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Subsequent content can be obtained based on the `ConText` returned last time. Up to 10,000 data entries can be obtained ConText *string `json:"ConText,omitempty" name:"ConText"` // Sorting by time. Valid values: asc (ascending), desc (descending). Default value: desc Sort *string `json:"Sort,omitempty" name:"Sort"` // Reserved field Query *string `json:"Query,omitempty" name:"Query"` // Search criterion. Valid values: // req_id: "=" // api_id: "=" // cip: "=" // uip: ":" // err_msg: ":" // rsp_st: "=", "!=", ":", ">", "<" // req_t: ">=", "<=" // // Note: // ":" indicates included, and "!=" indicates not equal to. For the meanings of fields, please see the `LogSet` description of the output parameter LogQuerys []*LogQuery `json:"LogQuerys,omitempty" name:"LogQuerys"` }
func NewDescribeLogSearchRequest ¶
func NewDescribeLogSearchRequest() (request *DescribeLogSearchRequest)
func (*DescribeLogSearchRequest) FromJsonString ¶
func (r *DescribeLogSearchRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLogSearchRequest) ToJsonString ¶
func (r *DescribeLogSearchRequest) ToJsonString() string
type DescribeLogSearchResponse ¶
type DescribeLogSearchResponse struct { *tchttp.BaseResponse Response *struct { // Cursor for getting more search results. If the value is `""`, there will be no subsequent results ConText *string `json:"ConText,omitempty" name:"ConText"` // The returned result contains any number of logs, which are in the following format: // '[$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]'; // // Note: // app_id: user ID. // env_name: environment name. // service_id: service ID. // http_host: domain name. // api_id: API ID. // uri: request path. // scheme: HTTP/HTTPS protocol. // rsp_st: request response status code. // ups_st: backend business server response status code (if the request is passed through to the backend, this variable will not be empty. If the request is blocked in API Gateway, this variable will be displayed as `-`). // cip: client IP. // uip: backend business service (upstream) IP. // vip: VIP requested to be accessed. // rsp_len: response length. // req_len: request length. // req_t: total request response time. // ups_rsp_t: total backend response time (time between connection establishment by API Gateway and backend response receipt). // ups_conn_t: time when the backend business server is successfully connected to. // ups_head_t: time when the backend response header arrives. // err_msg: error message. // tcp_rtt: client TCP connection information. RTT (Round Trip Time) consists of three parts: link propagation delay, end system processing delay, and queuing delay in router cache. // req_id: request ID. LogSet []*string `json:"LogSet,omitempty" name:"LogSet"` // Number of logs returned for one search (`TotalCount <= Limit`) TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeLogSearchResponse) ToJsonString ¶
func (r *DescribeLogSearchResponse) ToJsonString() string
type DescribePluginApisRequest ¶
type DescribePluginApisRequest struct { *tchttp.BaseRequest // ID of the plugin to be queried PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Number of returned results. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribePluginApisRequest ¶
func NewDescribePluginApisRequest() (request *DescribePluginApisRequest)
func (*DescribePluginApisRequest) FromJsonString ¶
func (r *DescribePluginApisRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePluginApisRequest) ToJsonString ¶
func (r *DescribePluginApisRequest) ToJsonString() string
type DescribePluginApisResponse ¶
type DescribePluginApisResponse struct { *tchttp.BaseResponse Response *struct { // List of APIs bound with the plugin Result *AttachedApiSummary `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribePluginApisResponse ¶
func NewDescribePluginApisResponse() (response *DescribePluginApisResponse)
func (*DescribePluginApisResponse) FromJsonString ¶
func (r *DescribePluginApisResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePluginApisResponse) ToJsonString ¶
func (r *DescribePluginApisResponse) ToJsonString() string
type DescribePluginRequest ¶
type DescribePluginRequest struct { *tchttp.BaseRequest // ID of the plugin to be queried PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Number of returned results. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribePluginRequest ¶
func NewDescribePluginRequest() (request *DescribePluginRequest)
func (*DescribePluginRequest) FromJsonString ¶
func (r *DescribePluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePluginRequest) ToJsonString ¶
func (r *DescribePluginRequest) ToJsonString() string
type DescribePluginResponse ¶
type DescribePluginResponse struct { *tchttp.BaseResponse Response *struct { // Plugin details Result *Plugin `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribePluginResponse ¶
func NewDescribePluginResponse() (response *DescribePluginResponse)
func (*DescribePluginResponse) FromJsonString ¶
func (r *DescribePluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePluginResponse) ToJsonString ¶
func (r *DescribePluginResponse) ToJsonString() string
type DescribeServiceEnvironmentListRequest ¶
type DescribeServiceEnvironmentListRequest struct { *tchttp.BaseRequest // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceEnvironmentListRequest ¶
func NewDescribeServiceEnvironmentListRequest() (request *DescribeServiceEnvironmentListRequest)
func (*DescribeServiceEnvironmentListRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentListRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentListRequest) ToJsonString() string
type DescribeServiceEnvironmentListResponse ¶
type DescribeServiceEnvironmentListResponse struct { *tchttp.BaseResponse Response *struct { // Details of environments bound to service. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServiceEnvironmentSet `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment name. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceEnvironmentReleaseHistoryRequest ¶
func NewDescribeServiceEnvironmentReleaseHistoryRequest() (request *DescribeServiceEnvironmentReleaseHistoryRequest)
func (*DescribeServiceEnvironmentReleaseHistoryRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentReleaseHistoryRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentReleaseHistoryRequest) ToJsonString() string
type DescribeServiceEnvironmentReleaseHistoryResponse ¶
type DescribeServiceEnvironmentReleaseHistoryResponse struct { *tchttp.BaseResponse Response *struct { // Service release history. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServiceReleaseHistory `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceEnvironmentStrategyRequest ¶
func NewDescribeServiceEnvironmentStrategyRequest() (request *DescribeServiceEnvironmentStrategyRequest)
func (*DescribeServiceEnvironmentStrategyRequest) FromJsonString ¶
func (r *DescribeServiceEnvironmentStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceEnvironmentStrategyRequest) ToJsonString ¶
func (r *DescribeServiceEnvironmentStrategyRequest) ToJsonString() string
type DescribeServiceEnvironmentStrategyResponse ¶
type DescribeServiceEnvironmentStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Throttling policy list. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServiceEnvironmentStrategyStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 DescribeServiceForApiAppRequest ¶
type DescribeServiceForApiAppRequest struct { *tchttp.BaseRequest // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Service region. ApiRegion *string `json:"ApiRegion,omitempty" name:"ApiRegion"` }
func NewDescribeServiceForApiAppRequest ¶
func NewDescribeServiceForApiAppRequest() (request *DescribeServiceForApiAppRequest)
func (*DescribeServiceForApiAppRequest) FromJsonString ¶
func (r *DescribeServiceForApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceForApiAppRequest) ToJsonString ¶
func (r *DescribeServiceForApiAppRequest) ToJsonString() string
type DescribeServiceForApiAppResponse ¶
type DescribeServiceForApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Service environment list. // Note: this field may return null, indicating that no valid values can be obtained. AvailableEnvironments []*string `json:"AvailableEnvironments,omitempty" name:"AvailableEnvironments"` // Service name. // Note: this field may return null, indicating that no valid values can be obtained. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Service description. // Note: this field may return null, indicating that no valid values can be obtained. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Protocol supported by service. Valid values: http, https, http&https. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Service creation time. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Service modification time. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Self-Deployed cluster name. // Note: this field may return null, indicating that no valid values can be obtained. ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"` // Network type list. INNER: private network access; OUTER: public network access. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` // Subdomain name for private network access. InternalSubDomain *string `json:"InternalSubDomain,omitempty" name:"InternalSubDomain"` // Subdomain name for public network access. OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"` // Service port number for HTTP access over private network. InnerHttpPort *int64 `json:"InnerHttpPort,omitempty" name:"InnerHttpPort"` // Port number for HTTPS access over private network. InnerHttpsPort *int64 `json:"InnerHttpsPort,omitempty" name:"InnerHttpsPort"` // Total number of APIs. // Note: this field may return null, indicating that no valid values can be obtained. ApiTotalCount *int64 `json:"ApiTotalCount,omitempty" name:"ApiTotalCount"` // API list. // Note: this field may return null, indicating that no valid values can be obtained. ApiIdStatusSet []*ApiIdStatus `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet"` // Total number of usage plans. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanTotalCount *int64 `json:"UsagePlanTotalCount,omitempty" name:"UsagePlanTotalCount"` // Usage plan array. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanList []*UsagePlan `json:"UsagePlanList,omitempty" name:"UsagePlanList"` // IP version. // Note: this field may return null, indicating that no valid values can be obtained. IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"` // Service user type. // Note: this field may return null, indicating that no valid values can be obtained. UserType *string `json:"UserType,omitempty" name:"UserType"` // Reserved field. // Note: this field may return null, indicating that no valid values can be obtained. SetId *int64 `json:"SetId,omitempty" name:"SetId"` // Tag bound to the service. // Note: this field may return null, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeServiceForApiAppResponse ¶
func NewDescribeServiceForApiAppResponse() (response *DescribeServiceForApiAppResponse)
func (*DescribeServiceForApiAppResponse) FromJsonString ¶
func (r *DescribeServiceForApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceForApiAppResponse) ToJsonString ¶
func (r *DescribeServiceForApiAppResponse) ToJsonString() string
type DescribeServiceReleaseVersionRequest ¶
type DescribeServiceReleaseVersionRequest struct { *tchttp.BaseRequest // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceReleaseVersionRequest ¶
func NewDescribeServiceReleaseVersionRequest() (request *DescribeServiceReleaseVersionRequest)
func (*DescribeServiceReleaseVersionRequest) FromJsonString ¶
func (r *DescribeServiceReleaseVersionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceReleaseVersionRequest) ToJsonString ¶
func (r *DescribeServiceReleaseVersionRequest) ToJsonString() string
type DescribeServiceReleaseVersionResponse ¶
type DescribeServiceReleaseVersionResponse struct { *tchttp.BaseResponse Response *struct { // Service release version list. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServiceReleaseVersion `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` }
func NewDescribeServiceRequest ¶
func NewDescribeServiceRequest() (request *DescribeServiceRequest)
func (*DescribeServiceRequest) FromJsonString ¶
func (r *DescribeServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceRequest) ToJsonString ¶
func (r *DescribeServiceRequest) ToJsonString() string
type DescribeServiceResponse ¶
type DescribeServiceResponse struct { *tchttp.BaseResponse Response *struct { // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Service environment list. AvailableEnvironments []*string `json:"AvailableEnvironments,omitempty" name:"AvailableEnvironments"` // Service name. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Service description. // Note: this field may return null, indicating that no valid values can be obtained. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Protocol supported by service. Valid values: http, https, http&https. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Service creation time. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Service modification time. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Dedicated cluster name. ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"` // Network type list. INNER: private network access; OUTER: public network access. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` // Subdomain name for private network access. InternalSubDomain *string `json:"InternalSubDomain,omitempty" name:"InternalSubDomain"` // Subdomain name for public network access. OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"` // Service port number for HTTP access over private network. InnerHttpPort *int64 `json:"InnerHttpPort,omitempty" name:"InnerHttpPort"` // Port number for HTTPS access over private network. InnerHttpsPort *int64 `json:"InnerHttpsPort,omitempty" name:"InnerHttpsPort"` // Total number of APIs. ApiTotalCount *int64 `json:"ApiTotalCount,omitempty" name:"ApiTotalCount"` // API list. // Note: this field may return null, indicating that no valid values can be obtained. ApiIdStatusSet []*ApiIdStatus `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet"` // Total number of usage plans. UsagePlanTotalCount *int64 `json:"UsagePlanTotalCount,omitempty" name:"UsagePlanTotalCount"` // Usage plan array. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanList []*UsagePlan `json:"UsagePlanList,omitempty" name:"UsagePlanList"` // IP version. // Note: this field may return null, indicating that no valid values can be obtained. IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"` // Service user type. // Note: this field may return null, indicating that no valid values can be obtained. UserType *string `json:"UserType,omitempty" name:"UserType"` // Reserved field. // Note: this field may return null, indicating that no valid values can be obtained. SetId *int64 `json:"SetId,omitempty" name:"SetId"` // Tags bound to a service. // Note: this field may return null, indicating that no valid values found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Dedicated instance ID // Note: this field may return null, indicating that no valid values can be obtained. InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` // Dedicated instance name // Note: this field may return null, indicating that no valid values can be obtained. InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"` // Cluster type // Note: this field may return null, indicating that no valid values can be obtained. SetType *string `json:"SetType,omitempty" name:"SetType"` // Cluster type for service deployment // Note: this field may return null, indicating that no valid values found. DeploymentType *string `json:"DeploymentType,omitempty" name:"DeploymentType"` // Whether it’s for special usage // Note: this field may return `null`, indicating that no valid values can be obtained. SpecialUse *string `json:"SpecialUse,omitempty" name:"SpecialUse"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceResponse) ToJsonString ¶
func (r *DescribeServiceResponse) ToJsonString() string
type DescribeServiceSubDomainMappingsRequest ¶
type DescribeServiceSubDomainMappingsRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom domain name bound to service. SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"` }
func NewDescribeServiceSubDomainMappingsRequest ¶
func NewDescribeServiceSubDomainMappingsRequest() (request *DescribeServiceSubDomainMappingsRequest)
func (*DescribeServiceSubDomainMappingsRequest) FromJsonString ¶
func (r *DescribeServiceSubDomainMappingsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceSubDomainMappingsRequest) ToJsonString ¶
func (r *DescribeServiceSubDomainMappingsRequest) ToJsonString() string
type DescribeServiceSubDomainMappingsResponse ¶
type DescribeServiceSubDomainMappingsResponse struct { *tchttp.BaseResponse Response *struct { // Custom path mapping list. Result *ServiceSubDomainMappings `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceSubDomainsRequest ¶
func NewDescribeServiceSubDomainsRequest() (request *DescribeServiceSubDomainsRequest)
func (*DescribeServiceSubDomainsRequest) FromJsonString ¶
func (r *DescribeServiceSubDomainsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceSubDomainsRequest) ToJsonString ¶
func (r *DescribeServiceSubDomainsRequest) ToJsonString() string
type DescribeServiceSubDomainsResponse ¶
type DescribeServiceSubDomainsResponse struct { *tchttp.BaseResponse Response *struct { // Custom service domain name query. Result *DomainSets `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceSubDomainsResponse) ToJsonString ¶
func (r *DescribeServiceSubDomainsResponse) ToJsonString() string
type DescribeServiceUsagePlanRequest ¶
type DescribeServiceUsagePlanRequest struct { *tchttp.BaseRequest // Unique ID of the service to be queried. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeServiceUsagePlanRequest ¶
func NewDescribeServiceUsagePlanRequest() (request *DescribeServiceUsagePlanRequest)
func (*DescribeServiceUsagePlanRequest) FromJsonString ¶
func (r *DescribeServiceUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceUsagePlanRequest) ToJsonString ¶
func (r *DescribeServiceUsagePlanRequest) ToJsonString() string
type DescribeServiceUsagePlanResponse ¶
type DescribeServiceUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // List of usage plans bound to service. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServiceUsagePlanSet `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServiceUsagePlanResponse) ToJsonString ¶
func (r *DescribeServiceUsagePlanResponse) ToJsonString() string
type DescribeServicesStatusRequest ¶
type DescribeServicesStatusRequest struct { *tchttp.BaseRequest // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Filter. Valid values: `ServiceId`, `ServiceName`, `NotUsagePlanId`, `Environment`, `IpVersion`, `InstanceId`, `NetType`, `EIAMAppId`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeServicesStatusRequest ¶
func NewDescribeServicesStatusRequest() (request *DescribeServicesStatusRequest)
func (*DescribeServicesStatusRequest) FromJsonString ¶
func (r *DescribeServicesStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServicesStatusRequest) ToJsonString ¶
func (r *DescribeServicesStatusRequest) ToJsonString() string
type DescribeServicesStatusResponse ¶
type DescribeServicesStatusResponse struct { *tchttp.BaseResponse Response *struct { // Service list query result. // Note: this field may return null, indicating that no valid values can be obtained. Result *ServicesStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeServicesStatusResponse) ToJsonString ¶
func (r *DescribeServicesStatusResponse) ToJsonString() string
type DescribeUsagePlanEnvironmentsRequest ¶
type DescribeUsagePlanEnvironmentsRequest struct { *tchttp.BaseRequest // Unique ID of the usage plan to be queried. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Binding type. Valid values: API, SERVICE. Default value: SERVICE. BindType *string `json:"BindType,omitempty" name:"BindType"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeUsagePlanEnvironmentsRequest ¶
func NewDescribeUsagePlanEnvironmentsRequest() (request *DescribeUsagePlanEnvironmentsRequest)
func (*DescribeUsagePlanEnvironmentsRequest) FromJsonString ¶
func (r *DescribeUsagePlanEnvironmentsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanEnvironmentsRequest) ToJsonString ¶
func (r *DescribeUsagePlanEnvironmentsRequest) ToJsonString() string
type DescribeUsagePlanEnvironmentsResponse ¶
type DescribeUsagePlanEnvironmentsResponse struct { *tchttp.BaseResponse Response *struct { // Usage plan binding details. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlanEnvironmentStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique ID of the usage plan to be queried. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` }
func NewDescribeUsagePlanRequest ¶
func NewDescribeUsagePlanRequest() (request *DescribeUsagePlanRequest)
func (*DescribeUsagePlanRequest) FromJsonString ¶
func (r *DescribeUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanRequest) ToJsonString ¶
func (r *DescribeUsagePlanRequest) ToJsonString() string
type DescribeUsagePlanResponse ¶
type DescribeUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // Usage plan details. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanResponse) ToJsonString ¶
func (r *DescribeUsagePlanResponse) ToJsonString() string
type DescribeUsagePlanSecretIdsRequest ¶
type DescribeUsagePlanSecretIdsRequest struct { *tchttp.BaseRequest // Unique ID of bound usage plan. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` }
func NewDescribeUsagePlanSecretIdsRequest ¶
func NewDescribeUsagePlanSecretIdsRequest() (request *DescribeUsagePlanSecretIdsRequest)
func (*DescribeUsagePlanSecretIdsRequest) FromJsonString ¶
func (r *DescribeUsagePlanSecretIdsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanSecretIdsRequest) ToJsonString ¶
func (r *DescribeUsagePlanSecretIdsRequest) ToJsonString() string
type DescribeUsagePlanSecretIdsResponse ¶
type DescribeUsagePlanSecretIdsResponse struct { *tchttp.BaseResponse Response *struct { // List of keys bound to usage plan. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlanBindSecretStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlanSecretIdsResponse) ToJsonString ¶
func (r *DescribeUsagePlanSecretIdsResponse) ToJsonString() string
type DescribeUsagePlansStatusRequest ¶
type DescribeUsagePlansStatusRequest struct { *tchttp.BaseRequest // Number of results to be returned. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // Offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Usage plan filter. Valid values: UsagePlanId, UsagePlanName, NotServiceId, NotApiId, Environment. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeUsagePlansStatusRequest ¶
func NewDescribeUsagePlansStatusRequest() (request *DescribeUsagePlansStatusRequest)
func (*DescribeUsagePlansStatusRequest) FromJsonString ¶
func (r *DescribeUsagePlansStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlansStatusRequest) ToJsonString ¶
func (r *DescribeUsagePlansStatusRequest) ToJsonString() string
type DescribeUsagePlansStatusResponse ¶
type DescribeUsagePlansStatusResponse struct { *tchttp.BaseResponse Response *struct { // Usage plan list. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlansStatus `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUsagePlansStatusResponse) ToJsonString ¶
func (r *DescribeUsagePlansStatusResponse) ToJsonString() string
type DetachPluginRequest ¶
type DetachPluginRequest struct { *tchttp.BaseRequest // ID of the plugin to be unbound PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // API environment EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // ID of the API to unbind from the plugin ApiId *string `json:"ApiId,omitempty" name:"ApiId"` }
func NewDetachPluginRequest ¶
func NewDetachPluginRequest() (request *DetachPluginRequest)
func (*DetachPluginRequest) FromJsonString ¶
func (r *DetachPluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetachPluginRequest) ToJsonString ¶
func (r *DetachPluginRequest) ToJsonString() string
type DetachPluginResponse ¶
type DetachPluginResponse struct { *tchttp.BaseResponse Response *struct { // Whether unbinding succeeded. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDetachPluginResponse ¶
func NewDetachPluginResponse() (response *DetachPluginResponse)
func (*DetachPluginResponse) FromJsonString ¶
func (r *DetachPluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DetachPluginResponse) ToJsonString ¶
func (r *DetachPluginResponse) ToJsonString() string
type DisableApiKeyRequest ¶
type DisableApiKeyRequest struct { *tchttp.BaseRequest // ID of the key to be disabled. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` }
func NewDisableApiKeyRequest ¶
func NewDisableApiKeyRequest() (request *DisableApiKeyRequest)
func (*DisableApiKeyRequest) FromJsonString ¶
func (r *DisableApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableApiKeyRequest) ToJsonString ¶
func (r *DisableApiKeyRequest) ToJsonString() string
type DisableApiKeyResponse ¶
type DisableApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // Whether the key is successfully disabled. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableApiKeyResponse) ToJsonString ¶
func (r *DisableApiKeyResponse) ToJsonString() string
type DocumentSDK ¶
type DocumentSDK struct { // Download link of generated file. Generated documents will be stored in COS. DocumentURL *string `json:"DocumentURL,omitempty" name:"DocumentURL"` // Download link of generated SDK file. Generated SDK files will be stored in COS. SdkURL *string `json:"SdkURL,omitempty" name:"SdkURL"` }
type DomainSetList ¶
type DomainSetList struct { // Domain name. DomainName *string `json:"DomainName,omitempty" name:"DomainName"` // Domain name resolution status. `1`: normal, `0`: failed Status *int64 `json:"Status,omitempty" name:"Status"` // Certificate ID. CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"` // Whether the default path mapping is used. IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"` // Custom domain name protocol type. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Network type. Valid values: INNER, OUTER. NetType *string `json:"NetType,omitempty" name:"NetType"` // Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding. IsForcedHttps *bool `json:"IsForcedHttps,omitempty" name:"IsForcedHttps"` // ICP filing status RegistrationStatus *bool `json:"RegistrationStatus,omitempty" name:"RegistrationStatus"` }
type DomainSets ¶
type DomainSets struct { // Number of custom domain names under service TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Custom service domain name list. DomainSet []*DomainSetList `json:"DomainSet,omitempty" name:"DomainSet"` }
type EnableApiKeyRequest ¶
type EnableApiKeyRequest struct { *tchttp.BaseRequest // ID of the key to be enabled. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` }
func NewEnableApiKeyRequest ¶
func NewEnableApiKeyRequest() (request *EnableApiKeyRequest)
func (*EnableApiKeyRequest) FromJsonString ¶
func (r *EnableApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableApiKeyRequest) ToJsonString ¶
func (r *EnableApiKeyRequest) ToJsonString() string
type EnableApiKeyResponse ¶
type EnableApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // Whether the key is successfully enabled. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableApiKeyResponse) ToJsonString ¶
func (r *EnableApiKeyResponse) ToJsonString() string
type Environment ¶
type Environment struct { // Environment name. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Access path. Url *string `json:"Url,omitempty" name:"Url"` // Release status. 1: published. 0: not published. Status *uint64 `json:"Status,omitempty" name:"Status"` // Running version. VersionName *string `json:"VersionName,omitempty" name:"VersionName"` }
type EnvironmentStrategy ¶
type EnvironmentStrategy struct { // Environment name EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Throttling value Quota *int64 `json:"Quota,omitempty" name:"Quota"` // Maximum quota value // Note: this field may return null, indicating that no valid values can be obtained. MaxQuota *int64 `json:"MaxQuota,omitempty" name:"MaxQuota"` }
type ErrorCodes ¶
type ErrorCodes struct { // Custom response configuration error code. // Note: this field may return null, indicating that no valid values can be obtained. Code *int64 `json:"Code,omitempty" name:"Code"` // Custom response configuration error message. // Note: this field may return null, indicating that no valid values can be obtained. Msg *string `json:"Msg,omitempty" name:"Msg"` // Custom response configuration error code remarks. // Note: this field may return null, indicating that no valid values can be obtained. Desc *string `json:"Desc,omitempty" name:"Desc"` // Custom error code conversion. // Note: this field may return null, indicating that no valid values can be obtained. ConvertedCode *int64 `json:"ConvertedCode,omitempty" name:"ConvertedCode"` // Whether to enable error code conversion. // Note: this field may return null, indicating that no valid values can be obtained. NeedConvert *bool `json:"NeedConvert,omitempty" name:"NeedConvert"` }
type GenerateApiDocumentRequest ¶
type GenerateApiDocumentRequest struct { *tchttp.BaseRequest // Unique service ID of the document to be created. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment of the service for which to create an SDK. GenEnvironment *string `json:"GenEnvironment,omitempty" name:"GenEnvironment"` // Programming language of the SDK to be created. Currently, only Python and JavaScript are supported. GenLanguage *string `json:"GenLanguage,omitempty" name:"GenLanguage"` }
func NewGenerateApiDocumentRequest ¶
func NewGenerateApiDocumentRequest() (request *GenerateApiDocumentRequest)
func (*GenerateApiDocumentRequest) FromJsonString ¶
func (r *GenerateApiDocumentRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateApiDocumentRequest) ToJsonString ¶
func (r *GenerateApiDocumentRequest) ToJsonString() string
type GenerateApiDocumentResponse ¶
type GenerateApiDocumentResponse struct { *tchttp.BaseResponse Response *struct { // API document and SDK link. Result *DocumentSDK `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 { // Whether health check is enabled. IsHealthCheck *bool `json:"IsHealthCheck,omitempty" name:"IsHealthCheck"` // Health check threshold. RequestVolumeThreshold *int64 `json:"RequestVolumeThreshold,omitempty" name:"RequestVolumeThreshold"` // Window size. SleepWindowInMilliseconds *int64 `json:"SleepWindowInMilliseconds,omitempty" name:"SleepWindowInMilliseconds"` // Threshold percentage. ErrorThresholdPercentage *int64 `json:"ErrorThresholdPercentage,omitempty" name:"ErrorThresholdPercentage"` }
type IPStrategy ¶
type IPStrategy struct { // Unique policy ID. // Note: this field may return null, indicating that no valid values can be obtained. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Custom policy name. // Note: this field may return null, indicating that no valid values can be obtained. StrategyName *string `json:"StrategyName,omitempty" name:"StrategyName"` // Policy type. Valid values: WHITE (allowlist), BLACK (blocklist). // Note: this field may return null, indicating that no valid values can be obtained. StrategyType *string `json:"StrategyType,omitempty" name:"StrategyType"` // IP list. // Note: this field may return null, indicating that no valid values can be obtained. StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Modification time // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Number of APIs bound to policy. // Note: this field may return null, indicating that no valid values can be obtained. BindApiTotalCount *int64 `json:"BindApiTotalCount,omitempty" name:"BindApiTotalCount"` // Bound API details. // Note: this field may return null, indicating that no valid values can be obtained. BindApis []*DesApisStatus `json:"BindApis,omitempty" name:"BindApis"` }
type IPStrategyApi ¶
type IPStrategyApi struct { // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Custom API name. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API type. Valid values: NORMAL (general API), TSF (microservice API). ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API path, such as `/path`. Path *string `json:"Path,omitempty" name:"Path"` // API request method, such as `GET`. Method *string `json:"Method,omitempty" name:"Method"` // Unique ID of another policy bound to API. OtherIPStrategyId *string `json:"OtherIPStrategyId,omitempty" name:"OtherIPStrategyId"` // Environment bound to API. OtherEnvironmentName *string `json:"OtherEnvironmentName,omitempty" name:"OtherEnvironmentName"` }
type IPStrategyApiStatus ¶
type IPStrategyApiStatus struct { // Number of APIs bound to environment. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Details of APIs bound to environment. // Note: this field may return null, indicating that no valid values can be obtained. ApiIdStatusSet []*IPStrategyApi `json:"ApiIdStatusSet,omitempty" name:"ApiIdStatusSet"` }
type IPStrategysStatus ¶
type IPStrategysStatus struct { // Number of policies. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Policy list. // Note: this field may return null, indicating that no valid values can be obtained. StrategySet []*IPStrategy `json:"StrategySet,omitempty" name:"StrategySet"` }
type MicroService ¶
type MicroService struct { // Microservice cluster ID. ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // Microservice namespace ID. NamespaceId *string `json:"NamespaceId,omitempty" name:"NamespaceId"` // Microservice name. MicroServiceName *string `json:"MicroServiceName,omitempty" name:"MicroServiceName"` }
type MicroServiceReq ¶
type MicroServiceReq struct { // Microservice cluster. ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // Microservice namespace. NamespaceId *string `json:"NamespaceId,omitempty" name:"NamespaceId"` // Microservice name. MicroServiceName *string `json:"MicroServiceName,omitempty" name:"MicroServiceName"` }
type ModifyAPIDocRequest ¶
type ModifyAPIDocRequest struct { *tchttp.BaseRequest // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` // API document name ApiDocName *string `json:"ApiDocName,omitempty" name:"ApiDocName"` // Service name ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Environment name Environment *string `json:"Environment,omitempty" name:"Environment"` // List of APIs for which to generate documents ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewModifyAPIDocRequest ¶
func NewModifyAPIDocRequest() (request *ModifyAPIDocRequest)
func (*ModifyAPIDocRequest) FromJsonString ¶
func (r *ModifyAPIDocRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyAPIDocRequest) ToJsonString ¶
func (r *ModifyAPIDocRequest) ToJsonString() string
type ModifyAPIDocResponse ¶
type ModifyAPIDocResponse struct { *tchttp.BaseResponse Response *struct { // Basic information of API document Result *APIDoc `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyAPIDocResponse) ToJsonString ¶
func (r *ModifyAPIDocResponse) ToJsonString() string
type ModifyApiAppRequest ¶
type ModifyApiAppRequest struct { *tchttp.BaseRequest // Unique application ID. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Modified application name ApiAppName *string `json:"ApiAppName,omitempty" name:"ApiAppName"` // Modified application description ApiAppDesc *string `json:"ApiAppDesc,omitempty" name:"ApiAppDesc"` }
func NewModifyApiAppRequest ¶
func NewModifyApiAppRequest() (request *ModifyApiAppRequest)
func (*ModifyApiAppRequest) FromJsonString ¶
func (r *ModifyApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiAppRequest) ToJsonString ¶
func (r *ModifyApiAppRequest) ToJsonString() string
type ModifyApiAppResponse ¶
type ModifyApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Whether modification succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyApiAppResponse ¶
func NewModifyApiAppResponse() (response *ModifyApiAppResponse)
func (*ModifyApiAppResponse) FromJsonString ¶
func (r *ModifyApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiAppResponse) ToJsonString ¶
func (r *ModifyApiAppResponse) ToJsonString() string
type ModifyApiEnvironmentStrategyRequest ¶
type ModifyApiEnvironmentStrategyRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Throttling value. Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"` // Environment name. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // API list. ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewModifyApiEnvironmentStrategyRequest ¶
func NewModifyApiEnvironmentStrategyRequest() (request *ModifyApiEnvironmentStrategyRequest)
func (*ModifyApiEnvironmentStrategyRequest) FromJsonString ¶
func (r *ModifyApiEnvironmentStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiEnvironmentStrategyRequest) ToJsonString ¶
func (r *ModifyApiEnvironmentStrategyRequest) ToJsonString() string
type ModifyApiEnvironmentStrategyResponse ¶
type ModifyApiEnvironmentStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether modification succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiEnvironmentStrategyResponse) ToJsonString ¶
func (r *ModifyApiEnvironmentStrategyResponse) ToJsonString() string
type ModifyApiIncrementRequest ¶
type ModifyApiIncrementRequest struct { *tchttp.BaseRequest // Service ID ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // API ID ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Authorization type of the API to be modified (you can select `OAUTH`, i.e., authorization API) BusinessType *string `json:"BusinessType,omitempty" name:"BusinessType"` // Public key value to be modified by OAuth API PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"` // OAuth API redirect address LoginRedirectUrl *string `json:"LoginRedirectUrl,omitempty" name:"LoginRedirectUrl"` }
func NewModifyApiIncrementRequest ¶
func NewModifyApiIncrementRequest() (request *ModifyApiIncrementRequest)
func (*ModifyApiIncrementRequest) FromJsonString ¶
func (r *ModifyApiIncrementRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiIncrementRequest) ToJsonString ¶
func (r *ModifyApiIncrementRequest) ToJsonString() string
type ModifyApiIncrementResponse ¶
type ModifyApiIncrementResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiIncrementResponse) ToJsonString ¶
func (r *ModifyApiIncrementResponse) ToJsonString() string
type ModifyApiRequest ¶
type ModifyApiRequest struct { *tchttp.BaseRequest // Unique service ID of API. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test). ServiceType *string `json:"ServiceType,omitempty" name:"ServiceType"` // Request frontend configuration. RequestConfig *RequestConfig `json:"RequestConfig,omitempty" name:"RequestConfig"` // Unique API ID. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // Custom API name. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // Custom API description. ApiDesc *string `json:"ApiDesc,omitempty" name:"ApiDesc"` // API type. Valid values: NORMAL, TSF. Default value: NORMAL. ApiType *string `json:"ApiType,omitempty" name:"ApiType"` // API authentication type. Valid values: SECRET, NONE, OAUTH, APP. Default value: NONE. AuthType *string `json:"AuthType,omitempty" name:"AuthType"` // Whether signature authentication is required. True: yes; False: no. This parameter is to be disused. AuthRequired *bool `json:"AuthRequired,omitempty" name:"AuthRequired"` // API backend service timeout period in seconds. ServiceTimeout *int64 `json:"ServiceTimeout,omitempty" name:"ServiceTimeout"` // API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Whether to enable CORS. True: yes; False: no. EnableCORS *bool `json:"EnableCORS,omitempty" name:"EnableCORS"` // Constant parameter. ConstantParameters []*ConstantParameter `json:"ConstantParameters,omitempty" name:"ConstantParameters"` // Frontend request parameter. RequestParameters []*ReqParameter `json:"RequestParameters,omitempty" name:"RequestParameters"` // This field is valid if `AuthType` is `OAUTH`. NORMAL: business API; OAUTH: authorization API. ApiBusinessType *string `json:"ApiBusinessType,omitempty" name:"ApiBusinessType"` // Returned message of API backend Mock, which is required if `ServiceType` is `Mock`. ServiceMockReturnMessage *string `json:"ServiceMockReturnMessage,omitempty" name:"ServiceMockReturnMessage"` // List of microservices bound to API. MicroServices []*MicroServiceReq `json:"MicroServices,omitempty" name:"MicroServices"` // Load balancing configuration of microservice. ServiceTsfLoadBalanceConf *TsfLoadBalanceConfResp `json:"ServiceTsfLoadBalanceConf,omitempty" name:"ServiceTsfLoadBalanceConf"` // Health check configuration of microservice. ServiceTsfHealthCheckConf *HealthCheckConf `json:"ServiceTsfHealthCheckConf,omitempty" name:"ServiceTsfHealthCheckConf"` // `target` type load balancing configuration (in beta test). TargetServicesLoadBalanceConf *int64 `json:"TargetServicesLoadBalanceConf,omitempty" name:"TargetServicesLoadBalanceConf"` // `target` health check configuration (in beta test). TargetServicesHealthCheckConf *HealthCheckConf `json:"TargetServicesHealthCheckConf,omitempty" name:"TargetServicesHealthCheckConf"` // SCF function name, which takes effect if the backend type is `SCF`. ServiceScfFunctionName *string `json:"ServiceScfFunctionName,omitempty" name:"ServiceScfFunctionName"` // SCF WebSocket registration function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionName *string `json:"ServiceWebsocketRegisterFunctionName,omitempty" name:"ServiceWebsocketRegisterFunctionName"` // SCF WebSocket cleanup function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionName *string `json:"ServiceWebsocketCleanupFunctionName,omitempty" name:"ServiceWebsocketCleanupFunctionName"` // SCF WebSocket transfer function, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionName *string `json:"ServiceWebsocketTransportFunctionName,omitempty" name:"ServiceWebsocketTransportFunctionName"` // SCF function namespace, which takes effect if the backend type is `SCF`. ServiceScfFunctionNamespace *string `json:"ServiceScfFunctionNamespace,omitempty" name:"ServiceScfFunctionNamespace"` // SCF function version, which takes effect if the backend type is `SCF`. ServiceScfFunctionQualifier *string `json:"ServiceScfFunctionQualifier,omitempty" name:"ServiceScfFunctionQualifier"` // SCF WebSocket registration function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionNamespace *string `json:"ServiceWebsocketRegisterFunctionNamespace,omitempty" name:"ServiceWebsocketRegisterFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketRegisterFunctionQualifier *string `json:"ServiceWebsocketRegisterFunctionQualifier,omitempty" name:"ServiceWebsocketRegisterFunctionQualifier"` // SCF WebSocket transfer function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionNamespace *string `json:"ServiceWebsocketTransportFunctionNamespace,omitempty" name:"ServiceWebsocketTransportFunctionNamespace"` // SCF WebSocket transfer function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketTransportFunctionQualifier *string `json:"ServiceWebsocketTransportFunctionQualifier,omitempty" name:"ServiceWebsocketTransportFunctionQualifier"` // SCF WebSocket cleanup function namespace, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionNamespace *string `json:"ServiceWebsocketCleanupFunctionNamespace,omitempty" name:"ServiceWebsocketCleanupFunctionNamespace"` // SCF WebSocket cleanup function version, which takes effect if the frontend type is `WEBSOCKET` and the backend type is `SCF`. ServiceWebsocketCleanupFunctionQualifier *string `json:"ServiceWebsocketCleanupFunctionQualifier,omitempty" name:"ServiceWebsocketCleanupFunctionQualifier"` // Whether to enable response integration, which takes effect if the backend type is `SCF`. ServiceScfIsIntegratedResponse *bool `json:"ServiceScfIsIntegratedResponse,omitempty" name:"ServiceScfIsIntegratedResponse"` // Billing after debugging starts (reserved field for marketplace). IsDebugAfterCharge *bool `json:"IsDebugAfterCharge,omitempty" name:"IsDebugAfterCharge"` // Tag. TagSpecifications *Tag `json:"TagSpecifications,omitempty" name:"TagSpecifications"` // Whether to delete the error codes for custom response configuration. If the value is left empty or `False`, the error codes will not be deleted. If the value is `True`, all custom response configuration error codes of the API will be deleted. IsDeleteResponseErrorCodes *bool `json:"IsDeleteResponseErrorCodes,omitempty" name:"IsDeleteResponseErrorCodes"` // Return type. ResponseType *string `json:"ResponseType,omitempty" name:"ResponseType"` // Sample response for successful custom response configuration. ResponseSuccessExample *string `json:"ResponseSuccessExample,omitempty" name:"ResponseSuccessExample"` // Sample response for failed custom response configuration. ResponseFailExample *string `json:"ResponseFailExample,omitempty" name:"ResponseFailExample"` // API backend service configuration. ServiceConfig *ServiceConfig `json:"ServiceConfig,omitempty" name:"ServiceConfig"` // Unique ID of associated authorization API, which takes effect only if `AuthType` is `OAUTH` and `ApiBusinessType` is `NORMAL`. It is the unique ID of the OAuth 2.0 authorization API bound to the business API. AuthRelationApiId *string `json:"AuthRelationApiId,omitempty" name:"AuthRelationApiId"` // API backend service parameter. ServiceParameters []*ServiceParameter `json:"ServiceParameters,omitempty" name:"ServiceParameters"` // OAuth configuration, which takes effect if `AuthType` is `OAUTH`. OauthConfig *OauthConfig `json:"OauthConfig,omitempty" name:"OauthConfig"` // Custom error code configuration. ResponseErrorCodes []*ResponseErrorCodeReq `json:"ResponseErrorCodes,omitempty" name:"ResponseErrorCodes"` // Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF. IsBase64Encoded *bool `json:"IsBase64Encoded,omitempty" name:"IsBase64Encoded"` // Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF. IsBase64Trigger *bool `json:"IsBase64Trigger,omitempty" name:"IsBase64Trigger"` // Header trigger rules. The number of rules cannot exceed 10. Base64EncodedTriggerRules []*Base64EncodedTriggerRule `json:"Base64EncodedTriggerRules,omitempty" name:"Base64EncodedTriggerRules"` }
func NewModifyApiRequest ¶
func NewModifyApiRequest() (request *ModifyApiRequest)
func (*ModifyApiRequest) FromJsonString ¶
func (r *ModifyApiRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiRequest) ToJsonString ¶
func (r *ModifyApiRequest) ToJsonString() string
type ModifyApiResponse ¶
type ModifyApiResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyApiResponse) ToJsonString ¶
func (r *ModifyApiResponse) ToJsonString() string
type ModifyIPStrategyRequest ¶
type ModifyIPStrategyRequest struct { *tchttp.BaseRequest // Unique service ID of the policy to be modified. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the policy to be modified. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Details of the policy to be modified. StrategyData *string `json:"StrategyData,omitempty" name:"StrategyData"` }
func NewModifyIPStrategyRequest ¶
func NewModifyIPStrategyRequest() (request *ModifyIPStrategyRequest)
func (*ModifyIPStrategyRequest) FromJsonString ¶
func (r *ModifyIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyIPStrategyRequest) ToJsonString ¶
func (r *ModifyIPStrategyRequest) ToJsonString() string
type ModifyIPStrategyResponse ¶
type ModifyIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether modification succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyIPStrategyResponse) ToJsonString ¶
func (r *ModifyIPStrategyResponse) ToJsonString() string
type ModifyPluginRequest ¶
type ModifyPluginRequest struct { *tchttp.BaseRequest // ID of the plugin to be modified PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Plugin name to be modified. A plugin name can contain up to 50 characters out of `a-z`, `A-Z`, `0-9`, and `_`, which must begin with a letter and end with a letter or a number. PluginName *string `json:"PluginName,omitempty" name:"PluginName"` // Plugin description to be modified. A description is within 200 characters. Description *string `json:"Description,omitempty" name:"Description"` // Plugin definition statement to be modified. The json format is supported. PluginData *string `json:"PluginData,omitempty" name:"PluginData"` }
func NewModifyPluginRequest ¶
func NewModifyPluginRequest() (request *ModifyPluginRequest)
func (*ModifyPluginRequest) FromJsonString ¶
func (r *ModifyPluginRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPluginRequest) ToJsonString ¶
func (r *ModifyPluginRequest) ToJsonString() string
type ModifyPluginResponse ¶
type ModifyPluginResponse struct { *tchttp.BaseResponse Response *struct { // Whether modification succeeded. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyPluginResponse ¶
func NewModifyPluginResponse() (response *ModifyPluginResponse)
func (*ModifyPluginResponse) FromJsonString ¶
func (r *ModifyPluginResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyPluginResponse) ToJsonString ¶
func (r *ModifyPluginResponse) ToJsonString() string
type ModifyServiceEnvironmentStrategyRequest ¶
type ModifyServiceEnvironmentStrategyRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Throttling value. Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"` // Environment list. EnvironmentNames []*string `json:"EnvironmentNames,omitempty" name:"EnvironmentNames"` }
func NewModifyServiceEnvironmentStrategyRequest ¶
func NewModifyServiceEnvironmentStrategyRequest() (request *ModifyServiceEnvironmentStrategyRequest)
func (*ModifyServiceEnvironmentStrategyRequest) FromJsonString ¶
func (r *ModifyServiceEnvironmentStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyServiceEnvironmentStrategyRequest) ToJsonString ¶
func (r *ModifyServiceEnvironmentStrategyRequest) ToJsonString() string
type ModifyServiceEnvironmentStrategyResponse ¶
type ModifyServiceEnvironmentStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether modification succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString 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 // Unique ID of the service to be modified. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Service name after modification. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Service description after modification. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Service frontend request type after modification, such as `http`, `https`, and `http&https`. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Network type list, which is used to specify the supported network types. INNER: private network access; OUTER: public network access. Default value: OUTER. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` }
func NewModifyServiceRequest ¶
func NewModifyServiceRequest() (request *ModifyServiceRequest)
func (*ModifyServiceRequest) FromJsonString ¶
func (r *ModifyServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyServiceRequest) ToJsonString ¶
func (r *ModifyServiceRequest) ToJsonString() string
type ModifyServiceResponse ¶
type ModifyServiceResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyServiceResponse) ToJsonString ¶
func (r *ModifyServiceResponse) ToJsonString() string
type ModifySubDomainRequest ¶
type ModifySubDomainRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom domain name whose path mapping is to be modified. SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"` // Whether to change to the default path mapping. true: use the default path mapping; false: use the custom path mapping. IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"` // Certificate ID, which is required if the HTTPS protocol is included. CertificateId *string `json:"CertificateId,omitempty" name:"CertificateId"` // Custom domain name protocol type after modification. Valid values: http, https, http&https. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Path mapping list after modification. PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet"` // Network type. Valid values: INNER, OUTER. NetType *string `json:"NetType,omitempty" name:"NetType"` // Whether to force HTTP requests to redirect to HTTPS. Default value: `false`. When this parameter is `true`, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding. IsForcedHttps *bool `json:"IsForcedHttps,omitempty" name:"IsForcedHttps"` }
func NewModifySubDomainRequest ¶
func NewModifySubDomainRequest() (request *ModifySubDomainRequest)
func (*ModifySubDomainRequest) FromJsonString ¶
func (r *ModifySubDomainRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySubDomainRequest) ToJsonString ¶
func (r *ModifySubDomainRequest) ToJsonString() string
type ModifySubDomainResponse ¶
type ModifySubDomainResponse struct { *tchttp.BaseResponse Response *struct { // Whether the custom domain name is successfully modified. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySubDomainResponse) ToJsonString ¶
func (r *ModifySubDomainResponse) ToJsonString() string
type ModifyUsagePlanRequest ¶
type ModifyUsagePlanRequest struct { *tchttp.BaseRequest // Unique usage plan ID. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Custom usage plan name after modification. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Custom usage plan description after modification. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is `-1`, which indicates no limit. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Limit of requests per second. Valid values: -1, [1,2000]. The default value is `-1`, which indicates no limit. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` }
func NewModifyUsagePlanRequest ¶
func NewModifyUsagePlanRequest() (request *ModifyUsagePlanRequest)
func (*ModifyUsagePlanRequest) FromJsonString ¶
func (r *ModifyUsagePlanRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyUsagePlanRequest) ToJsonString ¶
func (r *ModifyUsagePlanRequest) ToJsonString() string
type ModifyUsagePlanResponse ¶
type ModifyUsagePlanResponse struct { *tchttp.BaseResponse Response *struct { // Usage plan details. // Note: this field may return null, indicating that no valid values can be obtained. Result *UsagePlanInfo `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyUsagePlanResponse) ToJsonString ¶
func (r *ModifyUsagePlanResponse) ToJsonString() string
type OauthConfig ¶
type OauthConfig struct { // Public key for user token verification. PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"` // Token delivery location. TokenLocation *string `json:"TokenLocation,omitempty" name:"TokenLocation"` // Redirect address, which is used to guide user logins. LoginRedirectUrl *string `json:"LoginRedirectUrl,omitempty" name:"LoginRedirectUrl"` }
type PathMapping ¶
type Plugin ¶
type Plugin struct { // Plugin ID PluginId *string `json:"PluginId,omitempty" name:"PluginId"` // Plugin name PluginName *string `json:"PluginName,omitempty" name:"PluginName"` // Plugin type PluginType *string `json:"PluginType,omitempty" name:"PluginType"` // Plugin definition statement PluginData *string `json:"PluginData,omitempty" name:"PluginData"` // Plugin description // Note: this field may return null, indicating that no valid values can be obtained. Description *string `json:"Description,omitempty" name:"Description"` // Plugin creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Plugin modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Total number of APIs bound with the plugin // Note: this field may return null, indicating that no valid values can be obtained. AttachedApiTotalCount *int64 `json:"AttachedApiTotalCount,omitempty" name:"AttachedApiTotalCount"` // Information of the API bound with the plugin // Note: this field may return null, indicating that no valid values can be obtained. AttachedApis []*AttachedApiInfo `json:"AttachedApis,omitempty" name:"AttachedApis"` }
type ReleaseService ¶
type ReleaseService struct { // Release remarks. // Note: this field may return null, indicating that no valid values can be obtained. ReleaseDesc *string `json:"ReleaseDesc,omitempty" name:"ReleaseDesc"` // Published version ID. // Note: this field may return null, indicating that no valid values can be obtained. ReleaseVersion *string `json:"ReleaseVersion,omitempty" name:"ReleaseVersion"` }
type ReleaseServiceRequest ¶
type ReleaseServiceRequest struct { *tchttp.BaseRequest // Unique ID of the service to be published. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Name of the environment to be published. Valid values: test (test environment), prepub (pre-release environment), release (release environment). EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Release description. ReleaseDesc *string `json:"ReleaseDesc,omitempty" name:"ReleaseDesc"` // `apiId` list, which is reserved. Full API release is used by default. ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewReleaseServiceRequest ¶
func NewReleaseServiceRequest() (request *ReleaseServiceRequest)
func (*ReleaseServiceRequest) FromJsonString ¶
func (r *ReleaseServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ReleaseServiceRequest) ToJsonString ¶
func (r *ReleaseServiceRequest) ToJsonString() string
type ReleaseServiceResponse ¶
type ReleaseServiceResponse struct { *tchttp.BaseResponse Response *struct { // Release information. Result *ReleaseService `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ReleaseServiceResponse) ToJsonString ¶
func (r *ReleaseServiceResponse) ToJsonString() string
type ReqParameter ¶
type ReqParameter struct { // API frontend parameter name. Name *string `json:"Name,omitempty" name:"Name"` // Position of the API frontend parameter, such as the header. Supported values: `header`, `query`, and `path`. Position *string `json:"Position,omitempty" name:"Position"` // API frontend parameter type, such as `String` and `int`. Type *string `json:"Type,omitempty" name:"Type"` // Default value of API frontend parameter. DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"` // Whether the API frontend parameter is required. True: yes; False: no. Required *bool `json:"Required,omitempty" name:"Required"` // API frontend parameter remarks. Desc *string `json:"Desc,omitempty" name:"Desc"` }
type RequestConfig ¶
type RequestParameter ¶
type RequestParameter struct { // Request parameter name Name *string `json:"Name,omitempty" name:"Name"` // Description Desc *string `json:"Desc,omitempty" name:"Desc"` // Parameter position Position *string `json:"Position,omitempty" name:"Position"` // Parameter type Type *string `json:"Type,omitempty" name:"Type"` // Default value DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"` // Whether it is required Required *bool `json:"Required,omitempty" name:"Required"` }
type ResetAPIDocPasswordRequest ¶
type ResetAPIDocPasswordRequest struct { *tchttp.BaseRequest // API document ID ApiDocId *string `json:"ApiDocId,omitempty" name:"ApiDocId"` }
func NewResetAPIDocPasswordRequest ¶
func NewResetAPIDocPasswordRequest() (request *ResetAPIDocPasswordRequest)
func (*ResetAPIDocPasswordRequest) FromJsonString ¶
func (r *ResetAPIDocPasswordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetAPIDocPasswordRequest) ToJsonString ¶
func (r *ResetAPIDocPasswordRequest) ToJsonString() string
type ResetAPIDocPasswordResponse ¶
type ResetAPIDocPasswordResponse struct { *tchttp.BaseResponse Response *struct { // Basic information of API document Result *APIDoc `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetAPIDocPasswordResponse) ToJsonString ¶
func (r *ResetAPIDocPasswordResponse) ToJsonString() string
type ResponseErrorCodeReq ¶
type ResponseErrorCodeReq struct { // Custom response configuration error code. Code *int64 `json:"Code,omitempty" name:"Code"` // Custom response configuration error message. Msg *string `json:"Msg,omitempty" name:"Msg"` // Custom response configuration error code remarks. Desc *string `json:"Desc,omitempty" name:"Desc"` // Custom error code conversion. ConvertedCode *int64 `json:"ConvertedCode,omitempty" name:"ConvertedCode"` // Whether to enable error code conversion. NeedConvert *bool `json:"NeedConvert,omitempty" name:"NeedConvert"` }
type Service ¶
type Service struct { // Port for HTTPS access over private network. // Note: this field may return null, indicating that no valid values can be obtained. InnerHttpsPort *int64 `json:"InnerHttpsPort,omitempty" name:"InnerHttpsPort"` // Custom service description. // Note: this field may return null, indicating that no valid values can be obtained. ServiceDesc *string `json:"ServiceDesc,omitempty" name:"ServiceDesc"` // Service frontend request type, such as `http`, `https`, and `http&https`. // Note: this field may return null, indicating that no valid values can be obtained. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Network types supported by service. // Note: this field may return null, indicating that no valid values can be obtained. NetTypes []*string `json:"NetTypes,omitempty" name:"NetTypes"` // Dedicated cluster name. // Note: this field may return null, indicating that no valid values can be obtained. ExclusiveSetName *string `json:"ExclusiveSetName,omitempty" name:"ExclusiveSetName"` // Unique service ID. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // IP version. // Note: this field may return null, indicating that no valid values can be obtained. IpVersion *string `json:"IpVersion,omitempty" name:"IpVersion"` // List of published environments, such as test, prepub, and release. // Note: this field may return null, indicating that no valid values can be obtained. AvailableEnvironments []*string `json:"AvailableEnvironments,omitempty" name:"AvailableEnvironments"` // Custom service name. // Note: this field may return null, indicating that no valid values can be obtained. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` // Public domain name assigned by the system for this service. // Note: this field may return null, indicating that no valid values can be obtained. OuterSubDomain *string `json:"OuterSubDomain,omitempty" name:"OuterSubDomain"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Port for HTTP access over private network. // Note: this field may return null, indicating that no valid values can be obtained. InnerHttpPort *uint64 `json:"InnerHttpPort,omitempty" name:"InnerHttpPort"` // Private domain name automatically assigned by the system for this service. // Note: this field may return null, indicating that no valid values can be obtained. InnerSubDomain *string `json:"InnerSubDomain,omitempty" name:"InnerSubDomain"` // Billing status of service. // Note: this field may return null, indicating that no valid values can be obtained. TradeIsolateStatus *int64 `json:"TradeIsolateStatus,omitempty" name:"TradeIsolateStatus"` // Tags bound to a service. // Note: this field may return null, indicating that no valid values found. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Dedicated instance // Note: this field may return null, indicating that no valid values can be obtained. InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` // Cluster type // Note: this field may return null, indicating that no valid values can be obtained. SetType *string `json:"SetType,omitempty" name:"SetType"` // Cluster type for service deployment // Note: this field may return null, indicating that no valid values found. DeploymentType *string `json:"DeploymentType,omitempty" name:"DeploymentType"` }
type ServiceConfig ¶
type ServiceConfig struct { // Backend type, which takes effect when VPC is enabled. Valid values: `clb` and `upstream` (VPC channel) Product *string `json:"Product,omitempty" name:"Product"` // Unique VPC ID. UniqVpcId *string `json:"UniqVpcId,omitempty" name:"UniqVpcId"` // API backend service URL, which is required if `ServiceType` is `HTTP`. Url *string `json:"Url,omitempty" name:"Url"` // API backend service path, such as `/path`, which is required if `ServiceType` is `HTTP`. The frontend and backend paths can be different. Path *string `json:"Path,omitempty" name:"Path"` // API backend service request method, such as `GET`, which is required if `ServiceType` is `HTTP`. The frontend and backend methods can be different Method *string `json:"Method,omitempty" name:"Method"` }
type ServiceEnvironmentSet ¶
type ServiceEnvironmentSet struct { // Total number of environments bound to service. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of environments bound to service. // Note: this field may return null, indicating that no valid values can be obtained. EnvironmentList []*Environment `json:"EnvironmentList,omitempty" name:"EnvironmentList"` }
type ServiceEnvironmentStrategy ¶
type ServiceEnvironmentStrategy struct { // Environment name. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Access service environment URL. Url *string `json:"Url,omitempty" name:"Url"` // Release status. Status *int64 `json:"Status,omitempty" name:"Status"` // Published version number. // Note: this field may return null, indicating that no valid values can be obtained. VersionName *string `json:"VersionName,omitempty" name:"VersionName"` // Throttling value. Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"` // Maximum quota value // Note: this field may return null, indicating that no valid values can be obtained. MaxStrategy *int64 `json:"MaxStrategy,omitempty" name:"MaxStrategy"` }
type ServiceEnvironmentStrategyStatus ¶
type ServiceEnvironmentStrategyStatus struct { // Number of throttling policies. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Throttling policy list. // Note: this field may return null, indicating that no valid values can be obtained. EnvironmentList []*ServiceEnvironmentStrategy `json:"EnvironmentList,omitempty" name:"EnvironmentList"` }
type ServiceParameter ¶
type ServiceParameter struct { // API backend service parameter name, which is used only if `ServiceType` is `HTTP`. The frontend and backend parameter names can be different. // Note: this field may return null, indicating that no valid values can be obtained. Name *string `json:"Name,omitempty" name:"Name"` // Position of API backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. The positions of frontend and backend parameters can be different. // Note: this field may return null, indicating that no valid values can be obtained. Position *string `json:"Position,omitempty" name:"Position"` // Position of the API frontend parameter corresponding to the backend service parameter, such as `head`, which is used only if `ServiceType` is `HTTP`. // Note: this field may return null, indicating that no valid values can be obtained. RelevantRequestParameterPosition *string `json:"RelevantRequestParameterPosition,omitempty" name:"RelevantRequestParameterPosition"` // Name of the API frontend parameter corresponding to the backend service parameter, which is used only if `ServiceType` is `HTTP`. // Note: this field may return null, indicating that no valid values can be obtained. RelevantRequestParameterName *string `json:"RelevantRequestParameterName,omitempty" name:"RelevantRequestParameterName"` // Default value of API backend service parameter, which is used only if `ServiceType` is `HTTP`. // Note: this field may return null, indicating that no valid values can be obtained. DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"` // API backend service parameter remarks, which is used only if `ServiceType` is `HTTP`. // Note: this field may return null, indicating that no valid values can be obtained. RelevantRequestParameterDesc *string `json:"RelevantRequestParameterDesc,omitempty" name:"RelevantRequestParameterDesc"` // API backend service parameter type, which is used only if `ServiceType` is `HTTP`. // Note: this field may return null, indicating that no valid values can be obtained. RelevantRequestParameterType *string `json:"RelevantRequestParameterType,omitempty" name:"RelevantRequestParameterType"` }
type ServiceReleaseHistory ¶
type ServiceReleaseHistory struct { // Total number of published versions. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Historical version list. // Note: this field may return null, indicating that no valid values can be obtained. VersionList []*ServiceReleaseHistoryInfo `json:"VersionList,omitempty" name:"VersionList"` }
type ServiceReleaseHistoryInfo ¶
type ServiceReleaseHistoryInfo struct { // Version ID. // Note: this field may return null, indicating that no valid values can be obtained. VersionName *string `json:"VersionName,omitempty" name:"VersionName"` // Version description. // Note: this field may return null, indicating that no valid values can be obtained. VersionDesc *string `json:"VersionDesc,omitempty" name:"VersionDesc"` // Version release time. // Note: this field may return null, indicating that no valid values can be obtained. ReleaseTime *string `json:"ReleaseTime,omitempty" name:"ReleaseTime"` }
type ServiceReleaseVersion ¶
type ServiceReleaseVersion struct { // Total number of published versions. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Release version list. // Note: this field may return null, indicating that no valid values can be obtained. VersionList []*ServiceReleaseHistoryInfo `json:"VersionList,omitempty" name:"VersionList"` }
type ServiceSubDomainMappings ¶
type ServiceSubDomainMappings struct { // Whether the default path mapping is used. true: use the default path mapping; false: use the custom path mapping (`PathMappingSet` is required in this case). IsDefaultMapping *bool `json:"IsDefaultMapping,omitempty" name:"IsDefaultMapping"` // Custom path mapping list. PathMappingSet []*PathMapping `json:"PathMappingSet,omitempty" name:"PathMappingSet"` }
type ServiceUsagePlanSet ¶
type ServiceUsagePlanSet struct { // Total number of usage plans bound to service. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of usage plans bound to service. // Note: this field may return null, indicating that no valid values can be obtained. ServiceUsagePlanList []*ApiUsagePlan `json:"ServiceUsagePlanList,omitempty" name:"ServiceUsagePlanList"` }
type ServicesStatus ¶
type ServicesStatus struct { // Total number of services in list. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Service list details. // Note: this field may return null, indicating that no valid values can be obtained. ServiceSet []*Service `json:"ServiceSet,omitempty" name:"ServiceSet"` }
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"` // IP of the host where the CVM instance resides HostIp *string `json:"HostIp,omitempty" name:"HostIp"` // Docker IP DockerIp *string `json:"DockerIp,omitempty" name:"DockerIp"` }
type TsfLoadBalanceConfResp ¶
type TsfLoadBalanceConfResp struct { // Whether load balancing is enabled. // Note: this field may return null, indicating that no valid values can be obtained. IsLoadBalance *bool `json:"IsLoadBalance,omitempty" name:"IsLoadBalance"` // Load balancing method. // Note: this field may return null, indicating that no valid values can be obtained. Method *string `json:"Method,omitempty" name:"Method"` // Whether session persistence is enabled. // Note: this field may return null, indicating that no valid values can be obtained. SessionStickRequired *bool `json:"SessionStickRequired,omitempty" name:"SessionStickRequired"` // Session persistence timeout period. // Note: this field may return null, indicating that no valid values can be obtained. SessionStickTimeout *int64 `json:"SessionStickTimeout,omitempty" name:"SessionStickTimeout"` }
type UnBindEnvironmentRequest ¶
type UnBindEnvironmentRequest struct { *tchttp.BaseRequest // Binding type. Valid values: API, SERVICE. Default value: SERVICE. BindType *string `json:"BindType,omitempty" name:"BindType"` // List of unique IDs of the usage plans to be bound. UsagePlanIds []*string `json:"UsagePlanIds,omitempty" name:"UsagePlanIds"` // Service environment to be unbound. Environment *string `json:"Environment,omitempty" name:"Environment"` // Unique ID of the service to be unbound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID array, which is required if `BindType` is `API`. ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewUnBindEnvironmentRequest ¶
func NewUnBindEnvironmentRequest() (request *UnBindEnvironmentRequest)
func (*UnBindEnvironmentRequest) FromJsonString ¶
func (r *UnBindEnvironmentRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindEnvironmentRequest) ToJsonString ¶
func (r *UnBindEnvironmentRequest) ToJsonString() string
type UnBindEnvironmentResponse ¶
type UnBindEnvironmentResponse struct { *tchttp.BaseResponse Response *struct { // Whether unbinding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindEnvironmentResponse) ToJsonString ¶
func (r *UnBindEnvironmentResponse) ToJsonString() string
type UnBindIPStrategyRequest ¶
type UnBindIPStrategyRequest struct { *tchttp.BaseRequest // Unique ID of the service to be unbound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the IP policy to be unbound. StrategyId *string `json:"StrategyId,omitempty" name:"StrategyId"` // Environment to be unbound. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // List of APIs to be unbound. UnBindApiIds []*string `json:"UnBindApiIds,omitempty" name:"UnBindApiIds"` }
func NewUnBindIPStrategyRequest ¶
func NewUnBindIPStrategyRequest() (request *UnBindIPStrategyRequest)
func (*UnBindIPStrategyRequest) FromJsonString ¶
func (r *UnBindIPStrategyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindIPStrategyRequest) ToJsonString ¶
func (r *UnBindIPStrategyRequest) ToJsonString() string
type UnBindIPStrategyResponse ¶
type UnBindIPStrategyResponse struct { *tchttp.BaseResponse Response *struct { // Whether unbinding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindIPStrategyResponse) ToJsonString ¶
func (r *UnBindIPStrategyResponse) ToJsonString() string
type UnBindSecretIdsRequest ¶
type UnBindSecretIdsRequest struct { *tchttp.BaseRequest // Unique ID of the usage plan to be unbound. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Array of IDs of the keys to be unbound. AccessKeyIds []*string `json:"AccessKeyIds,omitempty" name:"AccessKeyIds"` }
func NewUnBindSecretIdsRequest ¶
func NewUnBindSecretIdsRequest() (request *UnBindSecretIdsRequest)
func (*UnBindSecretIdsRequest) FromJsonString ¶
func (r *UnBindSecretIdsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindSecretIdsRequest) ToJsonString ¶
func (r *UnBindSecretIdsRequest) ToJsonString() string
type UnBindSecretIdsResponse ¶
type UnBindSecretIdsResponse struct { *tchttp.BaseResponse Response *struct { // Whether unbinding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindSecretIdsResponse) ToJsonString ¶
func (r *UnBindSecretIdsResponse) ToJsonString() string
type UnBindSubDomainRequest ¶
type UnBindSubDomainRequest struct { *tchttp.BaseRequest // Unique service ID. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Custom domain name to be unbound. SubDomain *string `json:"SubDomain,omitempty" name:"SubDomain"` }
func NewUnBindSubDomainRequest ¶
func NewUnBindSubDomainRequest() (request *UnBindSubDomainRequest)
func (*UnBindSubDomainRequest) FromJsonString ¶
func (r *UnBindSubDomainRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindSubDomainRequest) ToJsonString ¶
func (r *UnBindSubDomainRequest) ToJsonString() string
type UnBindSubDomainResponse ¶
type UnBindSubDomainResponse struct { *tchttp.BaseResponse Response *struct { // Whether the custom domain name is successfully unbound. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnBindSubDomainResponse) ToJsonString ¶
func (r *UnBindSubDomainResponse) ToJsonString() string
type UnReleaseServiceRequest ¶
type UnReleaseServiceRequest struct { *tchttp.BaseRequest // Unique ID of the service to be deactivated. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Name of the environment to be deactivated. Valid values: test (test environment), prepub (pre-release environment), release (release environment). EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // List of APIs to be deactivated, which is a reserved field. ApiIds []*string `json:"ApiIds,omitempty" name:"ApiIds"` }
func NewUnReleaseServiceRequest ¶
func NewUnReleaseServiceRequest() (request *UnReleaseServiceRequest)
func (*UnReleaseServiceRequest) FromJsonString ¶
func (r *UnReleaseServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnReleaseServiceRequest) ToJsonString ¶
func (r *UnReleaseServiceRequest) ToJsonString() string
type UnReleaseServiceResponse ¶
type UnReleaseServiceResponse struct { *tchttp.BaseResponse Response *struct { // Whether deactivation succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnReleaseServiceResponse) ToJsonString ¶
func (r *UnReleaseServiceResponse) ToJsonString() string
type UnbindApiAppRequest ¶
type UnbindApiAppRequest struct { *tchttp.BaseRequest // Unique ID of the application to be bound. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Environment to be bound. Environment *string `json:"Environment,omitempty" name:"Environment"` // Unique ID of the service to be bound. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique ID of the API to be bound. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` }
func NewUnbindApiAppRequest ¶
func NewUnbindApiAppRequest() (request *UnbindApiAppRequest)
func (*UnbindApiAppRequest) FromJsonString ¶
func (r *UnbindApiAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindApiAppRequest) ToJsonString ¶
func (r *UnbindApiAppRequest) ToJsonString() string
type UnbindApiAppResponse ¶
type UnbindApiAppResponse struct { *tchttp.BaseResponse Response *struct { // Whether unbinding succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUnbindApiAppResponse ¶
func NewUnbindApiAppResponse() (response *UnbindApiAppResponse)
func (*UnbindApiAppResponse) FromJsonString ¶
func (r *UnbindApiAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindApiAppResponse) ToJsonString ¶
func (r *UnbindApiAppResponse) ToJsonString() string
type UpdateApiAppKeyRequest ¶
type UpdateApiAppKeyRequest struct { *tchttp.BaseRequest // Unique application ID. ApiAppId *string `json:"ApiAppId,omitempty" name:"ApiAppId"` // Application Key. ApiAppKey *string `json:"ApiAppKey,omitempty" name:"ApiAppKey"` // Application Secret. ApiAppSecret *string `json:"ApiAppSecret,omitempty" name:"ApiAppSecret"` }
func NewUpdateApiAppKeyRequest ¶
func NewUpdateApiAppKeyRequest() (request *UpdateApiAppKeyRequest)
func (*UpdateApiAppKeyRequest) FromJsonString ¶
func (r *UpdateApiAppKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateApiAppKeyRequest) ToJsonString ¶
func (r *UpdateApiAppKeyRequest) ToJsonString() string
type UpdateApiAppKeyResponse ¶
type UpdateApiAppKeyResponse struct { *tchttp.BaseResponse Response *struct { // Whether update succeeded. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUpdateApiAppKeyResponse ¶
func NewUpdateApiAppKeyResponse() (response *UpdateApiAppKeyResponse)
func (*UpdateApiAppKeyResponse) FromJsonString ¶
func (r *UpdateApiAppKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateApiAppKeyResponse) ToJsonString ¶
func (r *UpdateApiAppKeyResponse) ToJsonString() string
type UpdateApiKeyRequest ¶
type UpdateApiKeyRequest struct { *tchttp.BaseRequest // ID of the key to be changed. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` // Key to be updated, which is required when a custom key is updated. It can contain 10–50 letters, digits, and underscores. AccessKeySecret *string `json:"AccessKeySecret,omitempty" name:"AccessKeySecret"` }
func NewUpdateApiKeyRequest ¶
func NewUpdateApiKeyRequest() (request *UpdateApiKeyRequest)
func (*UpdateApiKeyRequest) FromJsonString ¶
func (r *UpdateApiKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateApiKeyRequest) ToJsonString ¶
func (r *UpdateApiKeyRequest) ToJsonString() string
type UpdateApiKeyResponse ¶
type UpdateApiKeyResponse struct { *tchttp.BaseResponse Response *struct { // Key details after change. // Note: this field may return null, indicating that no valid values can be obtained. Result *ApiKey `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateApiKeyResponse) ToJsonString ¶
func (r *UpdateApiKeyResponse) ToJsonString() string
type UpdateServiceRequest ¶
type UpdateServiceRequest struct { *tchttp.BaseRequest // Unique ID of the service to be switch. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Name of the environment to be switched to. Valid values: test (test environment), prepub (pre-release environment), release (release environment). EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Number of the version to be switched to. VersionName *string `json:"VersionName,omitempty" name:"VersionName"` // Switch description. UpdateDesc *string `json:"UpdateDesc,omitempty" name:"UpdateDesc"` }
func NewUpdateServiceRequest ¶
func NewUpdateServiceRequest() (request *UpdateServiceRequest)
func (*UpdateServiceRequest) FromJsonString ¶
func (r *UpdateServiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateServiceRequest) ToJsonString ¶
func (r *UpdateServiceRequest) ToJsonString() string
type UpdateServiceResponse ¶
type UpdateServiceResponse struct { *tchttp.BaseResponse Response *struct { // Whether the version is successfully switched. // Note: this field may return null, indicating that no valid values can be obtained. Result *bool `json:"Result,omitempty" name:"Result"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. 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
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateServiceResponse) ToJsonString ¶
func (r *UpdateServiceResponse) ToJsonString() string
type UsagePlan ¶
type UsagePlan struct { // Environment name. Environment *string `json:"Environment,omitempty" name:"Environment"` // Unique usage plan ID. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Usage plan name. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Usage plan description. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Usage plan QPS. `-1` indicates no limit. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` // Usage plan time. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Usage plan modification time. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` }
type UsagePlanBindEnvironment ¶
type UsagePlanBindEnvironment struct { // Environment name. // Note: this field may return null, indicating that no valid values can be obtained. EnvironmentName *string `json:"EnvironmentName,omitempty" name:"EnvironmentName"` // Unique service ID. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` }
type UsagePlanBindSecret ¶
type UsagePlanBindSecret struct { // Key ID. // Note: this field may return null, indicating that no valid values can be obtained. AccessKeyId *string `json:"AccessKeyId,omitempty" name:"AccessKeyId"` // Key name. // Note: this field may return null, indicating that no valid values can be obtained. SecretName *string `json:"SecretName,omitempty" name:"SecretName"` // Key status. 0: disabled. 1: enabled. // Note: this field may return null, indicating that no valid values can be obtained. Status *int64 `json:"Status,omitempty" name:"Status"` }
type UsagePlanBindSecretStatus ¶
type UsagePlanBindSecretStatus struct { // Number of keys bound to usage plan. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of key details. // Note: this field may return null, indicating that no valid values can be obtained. AccessKeyList []*UsagePlanBindSecret `json:"AccessKeyList,omitempty" name:"AccessKeyList"` }
type UsagePlanEnvironment ¶
type UsagePlanEnvironment struct { // Unique ID of bound service. // Note: this field may return null, indicating that no valid values can be obtained. ServiceId *string `json:"ServiceId,omitempty" name:"ServiceId"` // Unique API ID. // Note: this field may return null, indicating that no valid values can be obtained. ApiId *string `json:"ApiId,omitempty" name:"ApiId"` // API name. // Note: this field may return null, indicating that no valid values can be obtained. ApiName *string `json:"ApiName,omitempty" name:"ApiName"` // API path. // Note: this field may return null, indicating that no valid values can be obtained. Path *string `json:"Path,omitempty" name:"Path"` // API method. // Note: this field may return null, indicating that no valid values can be obtained. Method *string `json:"Method,omitempty" name:"Method"` // Name of bound environment. // Note: this field may return null, indicating that no valid values can be obtained. Environment *string `json:"Environment,omitempty" name:"Environment"` // Used quota. // Note: this field may return null, indicating that no valid values can be obtained. InUseRequestNum *int64 `json:"InUseRequestNum,omitempty" name:"InUseRequestNum"` // Maximum number of requests. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Maximum number of requests per second. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Service name. // Note: this field may return null, indicating that no valid values can be obtained. ServiceName *string `json:"ServiceName,omitempty" name:"ServiceName"` }
type UsagePlanEnvironmentStatus ¶
type UsagePlanEnvironmentStatus struct { // Number of environments of the service bound to usage plan. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Environment status of services bound to usage plan. // Note: this field may return null, indicating that no valid values can be obtained. EnvironmentList []*UsagePlanEnvironment `json:"EnvironmentList,omitempty" name:"EnvironmentList"` }
type UsagePlanInfo ¶
type UsagePlanInfo struct { // Unique usage plan ID. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Usage plan name. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Usage plan description. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Number of initialization calls. // Note: this field may return null, indicating that no valid values can be obtained. InitQuota *int64 `json:"InitQuota,omitempty" name:"InitQuota"` // Limit of requests per second. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` // Maximum number of calls. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Whether to hide. // Note: this field may return null, indicating that no valid values can be obtained. IsHide *int64 `json:"IsHide,omitempty" name:"IsHide"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` // Number of bound keys. // Note: this field may return null, indicating that no valid values can be obtained. BindSecretIdTotalCount *int64 `json:"BindSecretIdTotalCount,omitempty" name:"BindSecretIdTotalCount"` // Details of bound keys. // Note: this field may return null, indicating that no valid values can be obtained. BindSecretIds []*string `json:"BindSecretIds,omitempty" name:"BindSecretIds"` // Number of bound environments. // Note: this field may return null, indicating that no valid values can be obtained. BindEnvironmentTotalCount *int64 `json:"BindEnvironmentTotalCount,omitempty" name:"BindEnvironmentTotalCount"` // Details of bound environments. // Note: this field may return null, indicating that no valid values can be obtained. BindEnvironments []*UsagePlanBindEnvironment `json:"BindEnvironments,omitempty" name:"BindEnvironments"` }
type UsagePlanStatusInfo ¶
type UsagePlanStatusInfo struct { // Unique usage plan ID. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanId *string `json:"UsagePlanId,omitempty" name:"UsagePlanId"` // Custom usage plan name. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanName *string `json:"UsagePlanName,omitempty" name:"UsagePlanName"` // Custom usage plan description. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanDesc *string `json:"UsagePlanDesc,omitempty" name:"UsagePlanDesc"` // Maximum number of requests per second. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNumPreSec *int64 `json:"MaxRequestNumPreSec,omitempty" name:"MaxRequestNumPreSec"` // Total number of requests allowed. `-1` indicates no limit. // Note: this field may return null, indicating that no valid values can be obtained. MaxRequestNum *int64 `json:"MaxRequestNum,omitempty" name:"MaxRequestNum"` // Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. CreatedTime *string `json:"CreatedTime,omitempty" name:"CreatedTime"` // Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. // Note: this field may return null, indicating that no valid values can be obtained. ModifiedTime *string `json:"ModifiedTime,omitempty" name:"ModifiedTime"` }
type UsagePlansStatus ¶
type UsagePlansStatus struct { // Number of eligible usage plans. // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Usage plan list. // Note: this field may return null, indicating that no valid values can be obtained. UsagePlanStatusSet []*UsagePlanStatusInfo `json:"UsagePlanStatusSet,omitempty" name:"UsagePlanStatusSet"` }