public class DescribeApiHistoryResponseBody
extends com.aliyun.tea.TeaModel
| 限定符和类型 | 字段和说明 |
|---|---|
String |
allowSignatureMethod
If **AuthType** is set to **APP**, this parameter is required and it is used to specify the signature algorithm.
|
String |
apiId
The ID of the API.
|
String |
apiName
The name of the API.
|
String |
appCodeAuthType
The way in which AppCode authentication is supported.
|
String |
authType
The authentication method of the API.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyBackendConfig |
backendConfig
The backend configurations.
|
Boolean |
backendEnable
Indicates whether the backend service is enabled.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyConstantParameters |
constantParameters
The constant parameters.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyCustomSystemParameters |
customSystemParameters
The custom system parameters.
|
String |
deployedTime
The publishing time (UTC) of the API.
|
String |
description
The description of the API.
|
Boolean |
disableInternet
* If the value of **DisableInternet** is set to **true**, API calls are limited within the VPC.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyErrorCodeSamples |
errorCodeSamples
The sample error codes returned by the backend service.
|
String |
failResultSample
The sample error response from the backend service.
|
Boolean |
forceNonceCheck
* If the value of **ForceNonceCheck** is set to **true**, X-Ca-Nonce must be checked during the request.
|
String |
groupId
The ID of the API group.
|
String |
groupName
The name of the API group.
|
String |
historyVersion
The historical version number.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyOpenIdConnectConfig |
openIdConnectConfig
The configuration items of the third-party OpenID Connect authentication method.
|
String |
regionId
The region where the API is located.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestConfig |
requestConfig
The configuration items of API requests sent by the consumer to API Gateway.
|
String |
requestId
The ID of the request.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestParameters |
requestParameters
The parameters of API requests sent by the consumer to API Gateway.
|
String |
resultBodyModel
The return description of the API.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyResultDescriptions |
resultDescriptions
The return description of the API.
|
String |
resultSample
The sample response.
|
String |
resultType
The format of the return data.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceConfig |
serviceConfig
The information about a backend service call.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParameters |
serviceParameters
The parameters of API requests sent by API Gateway to the backend service.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParametersMap |
serviceParametersMap
The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.
|
String |
stageName
The environment to which the API is published.
|
String |
status
The status of the API you called.
|
DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodySystemParameters |
systemParameters
The common parameters of APIs in JSON format.
|
String |
visibility
Indicates whether the API is public.
|
String |
webSocketApiType
The type of the WebSocket API.
|
| 构造器和说明 |
|---|
DescribeApiHistoryResponseBody() |
@NameInMap(value="AllowSignatureMethod") public String allowSignatureMethod
If **AuthType** is set to **APP**, this parameter is required and it is used to specify the signature algorithm. If you did not specify a value, HmacSHA256 is used by default. Valid values:
* HmacSHA256
* HmacSHA1,HmacSHA256
@NameInMap(value="ApiId") public String apiId
The ID of the API.
@NameInMap(value="ApiName") public String apiName
The name of the API.
@NameInMap(value="AppCodeAuthType") public String appCodeAuthType
The way in which AppCode authentication is supported. Default value: DEFAULT. Valid values:
* DEFAULT: supported after being made available in Alibaba Cloud Marketplace.
* DISABLE: not supported.
* HEADER : supported only in the Header requests.
* HEADER_QUERY: supported in the Header or Query requests.
@NameInMap(value="AuthType") public String authType
The authentication method of the API. Valid values:
* **APP: Only authorized applications can call the API.**
* **ANONYMOUS: Anonymous users can call the API. Take note of the following rules:**
* All users who have obtained the API service information can call this API. API Gateway neither authenticates callers nor sets user-specific throttling policies. If this API is a public one, set throttling policies for it.
@NameInMap(value="BackendConfig") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyBackendConfig backendConfig
The backend configurations.
@NameInMap(value="BackendEnable") public Boolean backendEnable
Indicates whether the backend service is enabled.
@NameInMap(value="ConstantParameters") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyConstantParameters constantParameters
The constant parameters.
@NameInMap(value="CustomSystemParameters") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyCustomSystemParameters customSystemParameters
The custom system parameters.
@NameInMap(value="DeployedTime") public String deployedTime
The publishing time (UTC) of the API.
@NameInMap(value="Description") public String description
The description of the API.
@NameInMap(value="DisableInternet") public Boolean disableInternet
* If the value of **DisableInternet** is set to **true**, API calls are limited within the VPC.
* If the value of **DisableInternet** is set to **false**, the limit is lifted. The default value is false when you create an API.
@NameInMap(value="ErrorCodeSamples") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyErrorCodeSamples errorCodeSamples
The sample error codes returned by the backend service.
For more information, see [ErrorCodeSample](~~44392~~).
@NameInMap(value="FailResultSample") public String failResultSample
The sample error response from the backend service.
@NameInMap(value="ForceNonceCheck") public Boolean forceNonceCheck
* If the value of **ForceNonceCheck** is set to **true**, X-Ca-Nonce must be checked during the request. This is the unique identifier of the request and is identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.
* If the value of **ForceNonceCheck** is set to **false**, the X-Ca-Nonce is not checked. The default value is false when you create an API.
@NameInMap(value="GroupId") public String groupId
The ID of the API group.
@NameInMap(value="GroupName") public String groupName
The name of the API group.
@NameInMap(value="HistoryVersion") public String historyVersion
The historical version number.
@NameInMap(value="OpenIdConnectConfig") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyOpenIdConnectConfig openIdConnectConfig
The configuration items of the third-party OpenID Connect authentication method.
@NameInMap(value="RegionId") public String regionId
The region where the API is located.
@NameInMap(value="RequestConfig") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestConfig requestConfig
The configuration items of API requests sent by the consumer to API Gateway.
For more information, see [RequestConfig](~~43985~~).
@NameInMap(value="RequestId") public String requestId
The ID of the request.
@NameInMap(value="RequestParameters") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestParameters requestParameters
The parameters of API requests sent by the consumer to API Gateway.
For more information, see [RequestParameter](~~43986~~).
@NameInMap(value="ResultBodyModel") public String resultBodyModel
The return description of the API.
@NameInMap(value="ResultDescriptions") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyResultDescriptions resultDescriptions
The return description of the API.
@NameInMap(value="ResultSample") public String resultSample
The sample response.
@NameInMap(value="ResultType") public String resultType
The format of the return data.
@NameInMap(value="ServiceConfig") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceConfig serviceConfig
The information about a backend service call.
@NameInMap(value="ServiceParameters") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParameters serviceParameters
The parameters of API requests sent by API Gateway to the backend service.
For more information, see [ServiceParameter](~~43988~~).
@NameInMap(value="ServiceParametersMap") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParametersMap serviceParametersMap
The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.
For more information, see [ServiceParameterMap](~~43989~~).
@NameInMap(value="StageName") public String stageName
The environment to which the API is published.
* **RELEASE**
* **PRE**: the pre-release environment
* **TEST**
@NameInMap(value="Status") public String status
The status of the API you called.
@NameInMap(value="SystemParameters") public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodySystemParameters systemParameters
The common parameters of APIs in JSON format.
@NameInMap(value="Visibility") public String visibility
Indicates whether the API is public. Valid values:
* **PUBLIC: The API is public. Public APIs are displayed on the APIs page for all users after the APIs are published to the production environment.**
* **PRIVATE: The API is private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.
@NameInMap(value="WebSocketApiType") public String webSocketApiType
The type of the WebSocket API. Valid values:
* **COMMON**: general APIs
* **REGISTER**: APIs for registration
* **UNREGISTER**: APIs for deregistration
* **NOTIFY**: APIs for downstream notification
For more information, see [Two-way communication](~~66031~~).
public static DescribeApiHistoryResponseBody build(Map<String,?> map) throws Exception
Exceptionpublic DescribeApiHistoryResponseBody setAllowSignatureMethod(String allowSignatureMethod)
public String getAllowSignatureMethod()
public DescribeApiHistoryResponseBody setApiId(String apiId)
public String getApiId()
public DescribeApiHistoryResponseBody setApiName(String apiName)
public String getApiName()
public DescribeApiHistoryResponseBody setAppCodeAuthType(String appCodeAuthType)
public String getAppCodeAuthType()
public DescribeApiHistoryResponseBody setAuthType(String authType)
public String getAuthType()
public DescribeApiHistoryResponseBody setBackendConfig(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyBackendConfig backendConfig)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyBackendConfig getBackendConfig()
public DescribeApiHistoryResponseBody setBackendEnable(Boolean backendEnable)
public Boolean getBackendEnable()
public DescribeApiHistoryResponseBody setConstantParameters(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyConstantParameters constantParameters)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyConstantParameters getConstantParameters()
public DescribeApiHistoryResponseBody setCustomSystemParameters(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyCustomSystemParameters customSystemParameters)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyCustomSystemParameters getCustomSystemParameters()
public DescribeApiHistoryResponseBody setDeployedTime(String deployedTime)
public String getDeployedTime()
public DescribeApiHistoryResponseBody setDescription(String description)
public String getDescription()
public DescribeApiHistoryResponseBody setDisableInternet(Boolean disableInternet)
public Boolean getDisableInternet()
public DescribeApiHistoryResponseBody setErrorCodeSamples(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyErrorCodeSamples errorCodeSamples)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyErrorCodeSamples getErrorCodeSamples()
public DescribeApiHistoryResponseBody setFailResultSample(String failResultSample)
public String getFailResultSample()
public DescribeApiHistoryResponseBody setForceNonceCheck(Boolean forceNonceCheck)
public Boolean getForceNonceCheck()
public DescribeApiHistoryResponseBody setGroupId(String groupId)
public String getGroupId()
public DescribeApiHistoryResponseBody setGroupName(String groupName)
public String getGroupName()
public DescribeApiHistoryResponseBody setHistoryVersion(String historyVersion)
public String getHistoryVersion()
public DescribeApiHistoryResponseBody setOpenIdConnectConfig(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyOpenIdConnectConfig openIdConnectConfig)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyOpenIdConnectConfig getOpenIdConnectConfig()
public DescribeApiHistoryResponseBody setRegionId(String regionId)
public String getRegionId()
public DescribeApiHistoryResponseBody setRequestConfig(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestConfig requestConfig)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestConfig getRequestConfig()
public DescribeApiHistoryResponseBody setRequestId(String requestId)
public String getRequestId()
public DescribeApiHistoryResponseBody setRequestParameters(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestParameters requestParameters)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyRequestParameters getRequestParameters()
public DescribeApiHistoryResponseBody setResultBodyModel(String resultBodyModel)
public String getResultBodyModel()
public DescribeApiHistoryResponseBody setResultDescriptions(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyResultDescriptions resultDescriptions)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyResultDescriptions getResultDescriptions()
public DescribeApiHistoryResponseBody setResultSample(String resultSample)
public String getResultSample()
public DescribeApiHistoryResponseBody setResultType(String resultType)
public String getResultType()
public DescribeApiHistoryResponseBody setServiceConfig(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceConfig serviceConfig)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceConfig getServiceConfig()
public DescribeApiHistoryResponseBody setServiceParameters(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParameters serviceParameters)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParameters getServiceParameters()
public DescribeApiHistoryResponseBody setServiceParametersMap(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParametersMap serviceParametersMap)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodyServiceParametersMap getServiceParametersMap()
public DescribeApiHistoryResponseBody setStageName(String stageName)
public String getStageName()
public DescribeApiHistoryResponseBody setStatus(String status)
public String getStatus()
public DescribeApiHistoryResponseBody setSystemParameters(DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodySystemParameters systemParameters)
public DescribeApiHistoryResponseBody.DescribeApiHistoryResponseBodySystemParameters getSystemParameters()
public DescribeApiHistoryResponseBody setVisibility(String visibility)
public String getVisibility()
public DescribeApiHistoryResponseBody setWebSocketApiType(String webSocketApiType)
public String getWebSocketApiType()
Copyright © 2023. All rights reserved.