BatchRestartApplications-阿里云帮助中心

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:BatchRestartApplications

none

*All Resource

*

None

Request syntax

PUT /pop/v1/sam/app/batchRestartApplications HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The namespace ID.	cn-shanghai
AppIds	string	Yes	The application IDs. Separate multiple IDs with commas (,).	00893b3a-0e24-45ed-be0c-1f20e07b****

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information. Value description: If the request succeeds, a success message is returned. If the request fails, 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 response.
ChangeOrderId	string	The ID of the change process.	01db03d3-3ee9-48b3-b3d0-dfce2d88****
ErrorCode	string	The error code. Value description: If the request succeeds, this field is not returned. It is returned only if the request fails. For more information, see the "Error codes" section in this topic.	System.Upgrading
Code	string	The API status or POP error code. Value description: 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 applications were started. Valid values: true and false	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88****"
  },
  "ErrorCode": "System.Upgrading",
  "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	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	Mamespace.Have.No.Applications	There are no applications in this namespace.	There are no applications in this namespace.
400	Invalid.App.List.Not.Same.Namespace	The selected applications do not belong to the same namespace.	The selected applications does not belong to the same namespace.
400	user.indebt	The user has an outstanding payment.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.