public class DescribeApiResponseBody
extends com.aliyun.tea.TeaModel
| 限定符和类型 | 字段和说明 |
|---|---|
String |
allowSignatureMethod
The region ID of the API.
|
String |
apiId
The format of the response from the backend service.
|
String |
apiName
Specifies whether to enable backend services.
|
String |
appCodeAuthType
If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm.
|
String |
authType
The last modification time of the API.
|
DescribeApiResponseBody.DescribeApiResponseBodyBackendConfig |
backendConfig
The ID of the backend service.
|
Boolean |
backendEnable
Backend configurations
|
DescribeApiResponseBody.DescribeApiResponseBodyConstantParameters |
constantParameters
Description
|
String |
createdTime
The name of the API, which is unique in the group.
|
DescribeApiResponseBody.DescribeApiResponseBodyCustomSystemParameters |
customSystemParameters
Examples
|
DescribeApiResponseBody.DescribeApiResponseBodyDeployedInfos |
deployedInfos
The name of the runtime environment.
|
String |
description
The name of the API group.
|
Boolean |
disableInternet
The returned description of the API.
|
DescribeApiResponseBody.DescribeApiResponseBodyErrorCodeSamples |
errorCodeSamples
Error codes
|
String |
failResultSample
The security authentication method of the API.
|
Boolean |
forceNonceCheck
Specifies whether to make the API public.
|
String |
groupId
Specifies whether to enable the Mock mode.
|
String |
groupName
The ID of the API group.
|
String |
mock
The result returned for service mocking.
|
String |
mockResult
The creation time of the API.
|
String |
modifiedTime
The ID of the request.
|
DescribeApiResponseBody.DescribeApiResponseBodyOpenIdConnectConfig |
openIdConnectConfig
The OpenID Connect mode.
|
String |
regionId
Specifies whether to carry the header : X-Ca-Nonce when calling an API.
|
DescribeApiResponseBody.DescribeApiResponseBodyRequestConfig |
requestConfig
The body model.
|
String |
requestId
The description of the API.
|
DescribeApiResponseBody.DescribeApiResponseBodyRequestParameters |
requestParameters
The JSON Schema used for JSON validation when **ParameterType** is set to String.
|
String |
resultBodyModel
The sample response from the backend service.
|
DescribeApiResponseBody.DescribeApiResponseBodyResultDescriptions |
resultDescriptions
The returned description of the API.
|
String |
resultSample
If **AuthType** is set to **APP**, the valid values are:
* **DEFAULT**: The default value that is used if no other values are passed. |
String |
resultType
The type of the two-way communication API.
|
DescribeApiResponseBody.DescribeApiResponseBodyServiceConfig |
serviceConfig
The application name in AONE.
|
DescribeApiResponseBody.DescribeApiResponseBodyServiceParameters |
serviceParameters
The parameter location.
|
DescribeApiResponseBody.DescribeApiResponseBodyServiceParametersMap |
serviceParametersMap
The corresponding frontend parameter name.
|
DescribeApiResponseBody.DescribeApiResponseBodySystemParameters |
systemParameters
Examples
|
String |
visibility
The sample error response from the backend service.
|
String |
webSocketApiType
Specifies whether to limit API calls to within the VPC.
|
| 构造器和说明 |
|---|
DescribeApiResponseBody() |
@NameInMap(value="AllowSignatureMethod") public String allowSignatureMethod
The region ID of the API.
@NameInMap(value="ApiId") public String apiId
The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML.
@NameInMap(value="ApiName") public String apiName
Specifies whether to enable backend services.
@NameInMap(value="AppCodeAuthType") public String appCodeAuthType
If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:
* HmacSHA256
* HmacSHA1,HmacSHA256
@NameInMap(value="AuthType") public String authType
The last modification time of the API.
@NameInMap(value="BackendConfig") public DescribeApiResponseBody.DescribeApiResponseBodyBackendConfig backendConfig
The ID of the backend service.
@NameInMap(value="BackendEnable") public Boolean backendEnable
Backend configurations
@NameInMap(value="ConstantParameters") public DescribeApiResponseBody.DescribeApiResponseBodyConstantParameters constantParameters
Description
@NameInMap(value="CreatedTime") public String createdTime
The name of the API, which is unique in the group.
@NameInMap(value="CustomSystemParameters") public DescribeApiResponseBody.DescribeApiResponseBodyCustomSystemParameters customSystemParameters
Examples
@NameInMap(value="DeployedInfos") public DescribeApiResponseBody.DescribeApiResponseBodyDeployedInfos deployedInfos
The name of the runtime environment. Valid values: RELEASE and TEST.
@NameInMap(value="Description") public String description
The name of the API group.
@NameInMap(value="DisableInternet") public Boolean disableInternet
The returned description of the API.
@NameInMap(value="ErrorCodeSamples") public DescribeApiResponseBody.DescribeApiResponseBodyErrorCodeSamples errorCodeSamples
Error codes
@NameInMap(value="FailResultSample") public String failResultSample
The security authentication method of the API. Valid values:
* **APP**: Only authorized applications can call the API.
* **ANONYMOUS**: The API can be anonymously called. In this mode, you must take note of the following rules:
* All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.
* We recommend that you do not make the API whose security authentication method is ANONYMOUS available in Alibaba Cloud Marketplace because API Gateway cannot meter calls on the caller or limit the number of calls on the API. If you want to make the API group to which the API belongs available in Alibaba Cloud Marketplace, we recommend that you move the API to another group, set its type to PRIVATE, or set its security authentication method to APP.
* **APPOPENID**: The OpenID Connect account authentication method is used. Only applications authorized by OpenID Connect can call the API. If this method is selected, the OpenIdConnectConfig parameter is required.
@NameInMap(value="ForceNonceCheck") public Boolean forceNonceCheck
Specifies whether to make the API public. Valid values:
* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.
* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.
@NameInMap(value="GroupId") public String groupId
Specifies whether to enable the Mock mode. Valid values:
* OPEN: The Mock mode is enabled.
* CLOSED: The Mock mode is not enabled.
@NameInMap(value="GroupName") public String groupName
The ID of the API group.
@NameInMap(value="Mock") public String mock
The result returned for service mocking.
@NameInMap(value="MockResult") public String mockResult
The creation time of the API.
@NameInMap(value="ModifiedTime") public String modifiedTime
The ID of the request.
@NameInMap(value="OpenIdConnectConfig") public DescribeApiResponseBody.DescribeApiResponseBodyOpenIdConnectConfig openIdConnectConfig
The OpenID Connect mode. Valid values:
* **IDTOKEN**: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.
* **BUSINESS**: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.
@NameInMap(value="RegionId") public String regionId
Specifies whether to carry the header : X-Ca-Nonce when calling an API. This is the unique identifier of the request and is generally 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 reply attacks. Valid values:
* **true**: This field is forcibly checked when an API is requested to prevent replay attacks.
* **false**: This field is not checked.
@NameInMap(value="RequestConfig") public DescribeApiResponseBody.DescribeApiResponseBodyRequestConfig requestConfig
The body model.
@NameInMap(value="RequestId") public String requestId
The description of the API.
@NameInMap(value="RequestParameters") public DescribeApiResponseBody.DescribeApiResponseBodyRequestParameters requestParameters
The JSON Schema used for JSON validation when **ParameterType** is set to String.
@NameInMap(value="ResultBodyModel") public String resultBodyModel
The sample response from the backend service.
@NameInMap(value="ResultDescriptions") public DescribeApiResponseBody.DescribeApiResponseBodyResultDescriptions resultDescriptions
The returned description of the API.
@NameInMap(value="ResultSample") public String resultSample
If **AuthType** is set to **APP**, the valid values are:
* **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is used.
* **DISABLE**: The authentication is disabled.
* **HEADER**: AppCode can be placed in the Header parameter for authentication.
* **HEADER_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.
@NameInMap(value="ResultType") public String resultType
The type of the two-way communication API. Valid values:
* **COMMON**: general APIs
* **REGISTER**: registered APIs
* **UNREGISTER**: unregistered APIs
* **NOTIFY**: downstream notification
For more information, see [Two-way communication](~~66031~~).
@NameInMap(value="ServiceConfig") public DescribeApiResponseBody.DescribeApiResponseBodyServiceConfig serviceConfig
The application name in AONE.
@NameInMap(value="ServiceParameters") public DescribeApiResponseBody.DescribeApiResponseBodyServiceParameters serviceParameters
The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.
@NameInMap(value="ServiceParametersMap") public DescribeApiResponseBody.DescribeApiResponseBodyServiceParametersMap serviceParametersMap
The corresponding frontend parameter name. It must be included in RequestParametersObject and matches ApiParameterName in RequestParameter data.
@NameInMap(value="SystemParameters") public DescribeApiResponseBody.DescribeApiResponseBodySystemParameters systemParameters
Examples
@NameInMap(value="Visibility") public String visibility
The sample error response from the backend service.
@NameInMap(value="WebSocketApiType") public String webSocketApiType
Specifies whether to limit API calls to within the VPC. Valid values:
* **true**: Only API calls from the VPC are supported.
* **false**: API calls from the VPC and Internet are both supported.
public static DescribeApiResponseBody build(Map<String,?> map) throws Exception
Exceptionpublic DescribeApiResponseBody setAllowSignatureMethod(String allowSignatureMethod)
public String getAllowSignatureMethod()
public DescribeApiResponseBody setApiId(String apiId)
public String getApiId()
public DescribeApiResponseBody setApiName(String apiName)
public String getApiName()
public DescribeApiResponseBody setAppCodeAuthType(String appCodeAuthType)
public String getAppCodeAuthType()
public DescribeApiResponseBody setAuthType(String authType)
public String getAuthType()
public DescribeApiResponseBody setBackendConfig(DescribeApiResponseBody.DescribeApiResponseBodyBackendConfig backendConfig)
public DescribeApiResponseBody.DescribeApiResponseBodyBackendConfig getBackendConfig()
public DescribeApiResponseBody setBackendEnable(Boolean backendEnable)
public Boolean getBackendEnable()
public DescribeApiResponseBody setConstantParameters(DescribeApiResponseBody.DescribeApiResponseBodyConstantParameters constantParameters)
public DescribeApiResponseBody.DescribeApiResponseBodyConstantParameters getConstantParameters()
public DescribeApiResponseBody setCreatedTime(String createdTime)
public String getCreatedTime()
public DescribeApiResponseBody setCustomSystemParameters(DescribeApiResponseBody.DescribeApiResponseBodyCustomSystemParameters customSystemParameters)
public DescribeApiResponseBody.DescribeApiResponseBodyCustomSystemParameters getCustomSystemParameters()
public DescribeApiResponseBody setDeployedInfos(DescribeApiResponseBody.DescribeApiResponseBodyDeployedInfos deployedInfos)
public DescribeApiResponseBody.DescribeApiResponseBodyDeployedInfos getDeployedInfos()
public DescribeApiResponseBody setDescription(String description)
public String getDescription()
public DescribeApiResponseBody setDisableInternet(Boolean disableInternet)
public Boolean getDisableInternet()
public DescribeApiResponseBody setErrorCodeSamples(DescribeApiResponseBody.DescribeApiResponseBodyErrorCodeSamples errorCodeSamples)
public DescribeApiResponseBody.DescribeApiResponseBodyErrorCodeSamples getErrorCodeSamples()
public DescribeApiResponseBody setFailResultSample(String failResultSample)
public String getFailResultSample()
public DescribeApiResponseBody setForceNonceCheck(Boolean forceNonceCheck)
public Boolean getForceNonceCheck()
public DescribeApiResponseBody setGroupId(String groupId)
public String getGroupId()
public DescribeApiResponseBody setGroupName(String groupName)
public String getGroupName()
public DescribeApiResponseBody setMock(String mock)
public String getMock()
public DescribeApiResponseBody setMockResult(String mockResult)
public String getMockResult()
public DescribeApiResponseBody setModifiedTime(String modifiedTime)
public String getModifiedTime()
public DescribeApiResponseBody setOpenIdConnectConfig(DescribeApiResponseBody.DescribeApiResponseBodyOpenIdConnectConfig openIdConnectConfig)
public DescribeApiResponseBody.DescribeApiResponseBodyOpenIdConnectConfig getOpenIdConnectConfig()
public DescribeApiResponseBody setRegionId(String regionId)
public String getRegionId()
public DescribeApiResponseBody setRequestConfig(DescribeApiResponseBody.DescribeApiResponseBodyRequestConfig requestConfig)
public DescribeApiResponseBody.DescribeApiResponseBodyRequestConfig getRequestConfig()
public DescribeApiResponseBody setRequestId(String requestId)
public String getRequestId()
public DescribeApiResponseBody setRequestParameters(DescribeApiResponseBody.DescribeApiResponseBodyRequestParameters requestParameters)
public DescribeApiResponseBody.DescribeApiResponseBodyRequestParameters getRequestParameters()
public DescribeApiResponseBody setResultBodyModel(String resultBodyModel)
public String getResultBodyModel()
public DescribeApiResponseBody setResultDescriptions(DescribeApiResponseBody.DescribeApiResponseBodyResultDescriptions resultDescriptions)
public DescribeApiResponseBody.DescribeApiResponseBodyResultDescriptions getResultDescriptions()
public DescribeApiResponseBody setResultSample(String resultSample)
public String getResultSample()
public DescribeApiResponseBody setResultType(String resultType)
public String getResultType()
public DescribeApiResponseBody setServiceConfig(DescribeApiResponseBody.DescribeApiResponseBodyServiceConfig serviceConfig)
public DescribeApiResponseBody.DescribeApiResponseBodyServiceConfig getServiceConfig()
public DescribeApiResponseBody setServiceParameters(DescribeApiResponseBody.DescribeApiResponseBodyServiceParameters serviceParameters)
public DescribeApiResponseBody.DescribeApiResponseBodyServiceParameters getServiceParameters()
public DescribeApiResponseBody setServiceParametersMap(DescribeApiResponseBody.DescribeApiResponseBodyServiceParametersMap serviceParametersMap)
public DescribeApiResponseBody.DescribeApiResponseBodyServiceParametersMap getServiceParametersMap()
public DescribeApiResponseBody setSystemParameters(DescribeApiResponseBody.DescribeApiResponseBodySystemParameters systemParameters)
public DescribeApiResponseBody.DescribeApiResponseBodySystemParameters getSystemParameters()
public DescribeApiResponseBody setVisibility(String visibility)
public String getVisibility()
public DescribeApiResponseBody setWebSocketApiType(String webSocketApiType)
public String getWebSocketApiType()
Copyright © 2023. All rights reserved.