All Products
Search
Document Center

:DescribeEdasContainers

Last Updated:Dec 05, 2024

Queries the container components of a microservices application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
sae:DescribeEdasContainersget
*All Resources
*
    none
none

Request syntax

GET /pop/v1/sam/resource/edasContainers HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The returned message.

success
TraceIdstring

The ID of the trace. It is used to query the details of a request.

0a98a02315955564772843261e****
Dataarray<object>

The list of components.

Dataobject
Disabledboolean

Indicates whether the component is disabled. Valid values:

  • true: indicates that the component is disabled.
  • false: indicates that the component is not disabled.
false
EdasContainerVersionstring

The version of the container, such as Ali-Tomcat, in which a High-speed Service Framework (HSF) application runs.

3.5.3
ErrorCodestring

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
200
Successboolean

Indicates whether the list of container components of a microservice application was obtained. Valid values:

  • true: indicates that the list was obtained.
  • false: indicates that the list could not be obtained.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Disabled": false,
      "EdasContainerVersion": "3.5.3"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history