All Products
Search
Document Center

Enterprise Distributed Application Service:GetWebContainerConfig

Last Updated:Jan 08, 2024

Queries the Tomcat configurations of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:application/{#AppId}
    none
none

Request syntax

GET /pop/v5/oam/web_container_config

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

5a166fbd-****-****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

4823-bhjf-23u4-eiufh
WebContainerConfigobject

The Tomcat configurations of the application.

ContextPathstring

The context path.

ROOT
UseAdvancedServerXmlboolean

Indicates whether advanced configurations are used to customize the server.xml file.

true
UseDefaultConfigboolean

Indicates whether the default configurations are used.

true
HttpPortinteger

The HTTP service port.

8080
ContextInputTypestring

The type of the context path.

root
UseBodyEncodingboolean

Indicates whether the encoding scheme specified in the request body is used for uniform resource identifier (URI) query parameters.

true
UriEncodingstring

The URI encoding scheme.

ISO-8859-1
MaxThreadsinteger

The maximum number of threads.

500
ServerXmlstring

The content of the server.xml file customized by using advanced configurations.

<Server port=*****

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "4823-bhjf-23u4-eiufh",
  "WebContainerConfig": {
    "ContextPath": "ROOT",
    "UseAdvancedServerXml": true,
    "UseDefaultConfig": true,
    "HttpPort": 8080,
    "ContextInputType": "root",
    "UseBodyEncoding": true,
    "UriEncoding": "ISO-8859-1",
    "MaxThreads": 500,
    "ServerXml": "<Server port=*****"
  }
}

Error codes

HTTP status codeError codeError message
500UnknownErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.