DescribeApplicationMseService-阿里云帮助中心

Queries the information of the associated MSE microservice governance application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribeApplicationMseService

*All Resource

*

None

Request syntax

GET /pop/v1/sam/app/applicationMseService HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
EnableAhas	boolean	Yes	Specifies whether to enable traffic limiting and degradation. Set to true to check traffic limiting and degradation permissions when accessing related APIs; set to false otherwise.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Message	string	The additional information. Value description: If the request was successful, success is returned. If the request failed, an error code is returned.	success
TraceId	string	The ID of the trace, which is used to query the exact call information.	0a98a02315955564772843261e****
Data	object	The application information.
MseAppId	string	The application ID.	mse-cn-hvm47******
MseAppName	string	The application name.	test
MseAppNameSpace	string	The namespace.	sae-ent
Status	string	The application status. Valid values: EXPIRED REBOOTING WAITING FAIL NULL/SUCCESS	SUCCESS
ErrorCode	string	The error code. Value description: If the request succeeds, this field is not returned. For more information, see the Error codes section of this topic.	System.Upgrading
Code	string	The API status or POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the application instance groups were obtained successfully. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "MseAppId": "mse-cn-hvm47******",
    "MseAppName": "test",
    "MseAppNameSpace": "sae-ent",
    "Status": "SUCCESS"
  },
  "ErrorCode": "System.Upgrading\t",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	System.Upgrading	The system is being upgraded. Please try again later.
400	InvalidApplication.NotFound	The current application does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.