public class DescribeDeployedApiResponseBody
extends com.aliyun.tea.TeaModel
| 限定符和类型 | 字段和说明 |
|---|---|
String |
allowSignatureMethod
The signature method used by the client.
|
String |
apiId
The ID of the API.
|
String |
apiName
The name of the API operation.
|
String |
authType
The authentication method of the API.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyConstantParameters |
constantParameters
The constant parameters.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyCustomSystemParameters |
customSystemParameters
The custom system parameters.
|
String |
deployedTime
The deployment time.
|
String |
description
Description
|
Boolean |
disableInternet
* If the value of DisableInternet is set to **true**, API calls are limited within the VPC.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyErrorCodeSamples |
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.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyOpenIdConnectConfig |
openIdConnectConfig
The configuration items of the third-party OpenID Connect authentication method.
|
String |
regionId
The region to which the API group belongs.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestConfig |
requestConfig
The configuration items of API requests sent by the consumer to API Gateway.
|
String |
requestId
The ID of the request.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestParameters |
requestParameters
The parameters of API requests sent by the consumer to API Gateway.
|
String |
resultBodyModel
The return description of the API.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyResultDescriptions |
resultDescriptions
The return descriptions of the API.
|
String |
resultSample
The sample response from the backend service.
|
String |
resultType
The format of the response from the backend service.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceConfig |
serviceConfig
The configuration items of API requests sent by API Gateway to the backend service.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParameters |
serviceParameters
The parameters of API requests sent by API Gateway to the backend service.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParametersMap |
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 name of the runtime environment.
|
DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodySystemParameters |
systemParameters
The system parameters.
|
String |
visibility
Indicates whether the API is public.
|
| 构造器和说明 |
|---|
DescribeDeployedApiResponseBody() |
@NameInMap(value="AllowSignatureMethod") public String allowSignatureMethod
The signature method used by the client. 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 operation.
@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="ConstantParameters") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyConstantParameters constantParameters
The constant parameters.
@NameInMap(value="CustomSystemParameters") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyCustomSystemParameters customSystemParameters
The custom system parameters.
@NameInMap(value="DeployedTime") public String deployedTime
The deployment time. Format: yyyy-mm-ddhh:mm:ss.
@NameInMap(value="Description") public String description
Description
@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.
> If you do not configure this parameter when you modify the API, the original value is used.
@NameInMap(value="ErrorCodeSamples") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyErrorCodeSamples 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="OpenIdConnectConfig") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyOpenIdConnectConfig openIdConnectConfig
The configuration items of the third-party OpenID Connect authentication method.
@NameInMap(value="RegionId") public String regionId
The region to which the API group belongs.
@NameInMap(value="RequestConfig") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestConfig 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 DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestParameters 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 DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyResultDescriptions resultDescriptions
The return descriptions of the API.
@NameInMap(value="ResultSample") public String resultSample
The sample response from the backend service.
@NameInMap(value="ResultType") public String resultType
The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.
@NameInMap(value="ServiceConfig") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceConfig serviceConfig
The configuration items of API requests sent by API Gateway to the backend service.
For more information, see [ServiceConfig](~~43987~~).
@NameInMap(value="ServiceParameters") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParameters serviceParameters
The parameters of API requests sent by API Gateway to the backend service.
For more information, see [ServiceParameter](~~43988~~).
@NameInMap(value="ServiceParametersMap") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParametersMap 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 name of the runtime environment. Valid values:
* **RELEASE**
* **PRE**: the pre-release environment
* **TEST**
@NameInMap(value="SystemParameters") public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodySystemParameters systemParameters
The system parameters.
@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.
public static DescribeDeployedApiResponseBody build(Map<String,?> map) throws Exception
Exceptionpublic DescribeDeployedApiResponseBody setAllowSignatureMethod(String allowSignatureMethod)
public String getAllowSignatureMethod()
public DescribeDeployedApiResponseBody setApiId(String apiId)
public String getApiId()
public DescribeDeployedApiResponseBody setApiName(String apiName)
public String getApiName()
public DescribeDeployedApiResponseBody setAuthType(String authType)
public String getAuthType()
public DescribeDeployedApiResponseBody setConstantParameters(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyConstantParameters constantParameters)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyConstantParameters getConstantParameters()
public DescribeDeployedApiResponseBody setCustomSystemParameters(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyCustomSystemParameters customSystemParameters)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyCustomSystemParameters getCustomSystemParameters()
public DescribeDeployedApiResponseBody setDeployedTime(String deployedTime)
public String getDeployedTime()
public DescribeDeployedApiResponseBody setDescription(String description)
public String getDescription()
public DescribeDeployedApiResponseBody setDisableInternet(Boolean disableInternet)
public Boolean getDisableInternet()
public DescribeDeployedApiResponseBody setErrorCodeSamples(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyErrorCodeSamples errorCodeSamples)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyErrorCodeSamples getErrorCodeSamples()
public DescribeDeployedApiResponseBody setFailResultSample(String failResultSample)
public String getFailResultSample()
public DescribeDeployedApiResponseBody setForceNonceCheck(Boolean forceNonceCheck)
public Boolean getForceNonceCheck()
public DescribeDeployedApiResponseBody setGroupId(String groupId)
public String getGroupId()
public DescribeDeployedApiResponseBody setGroupName(String groupName)
public String getGroupName()
public DescribeDeployedApiResponseBody setOpenIdConnectConfig(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyOpenIdConnectConfig openIdConnectConfig)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyOpenIdConnectConfig getOpenIdConnectConfig()
public DescribeDeployedApiResponseBody setRegionId(String regionId)
public String getRegionId()
public DescribeDeployedApiResponseBody setRequestConfig(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestConfig requestConfig)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestConfig getRequestConfig()
public DescribeDeployedApiResponseBody setRequestId(String requestId)
public String getRequestId()
public DescribeDeployedApiResponseBody setRequestParameters(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestParameters requestParameters)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyRequestParameters getRequestParameters()
public DescribeDeployedApiResponseBody setResultBodyModel(String resultBodyModel)
public String getResultBodyModel()
public DescribeDeployedApiResponseBody setResultDescriptions(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyResultDescriptions resultDescriptions)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyResultDescriptions getResultDescriptions()
public DescribeDeployedApiResponseBody setResultSample(String resultSample)
public String getResultSample()
public DescribeDeployedApiResponseBody setResultType(String resultType)
public String getResultType()
public DescribeDeployedApiResponseBody setServiceConfig(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceConfig serviceConfig)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceConfig getServiceConfig()
public DescribeDeployedApiResponseBody setServiceParameters(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParameters serviceParameters)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParameters getServiceParameters()
public DescribeDeployedApiResponseBody setServiceParametersMap(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParametersMap serviceParametersMap)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodyServiceParametersMap getServiceParametersMap()
public DescribeDeployedApiResponseBody setStageName(String stageName)
public String getStageName()
public DescribeDeployedApiResponseBody setSystemParameters(DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodySystemParameters systemParameters)
public DescribeDeployedApiResponseBody.DescribeDeployedApiResponseBodySystemParameters getSystemParameters()
public DescribeDeployedApiResponseBody setVisibility(String visibility)
public String getVisibility()
Copyright © 2023. All rights reserved.