BatchStopApplications

更新时间:
复制 MD 格式

Stop applications in batches.

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

none

*All Resource

*

None None

Request syntax

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

Request parameters

Parameter

Type

Required

Description

Example

NamespaceId

string

Yes

ebf491f0-c1a5-45e2-b2c4-710dbe2a****,ebf491f0-c1a5-45e2-b2c4-71025e2a****

cn-shanghai

AppIds

string

No

The ID of the application that you want to stop.

Note

If you want to stop multiple applications at the same time, separate the IDs with commas (,).

ebf491f0-c1a5-45e2-b2c4-710dbe2a****

Version

string

No

The application version.

1.0

Response elements

Element

Type

Description

Example

object

RequestId

string

The returned message.

  • success is returned when the request succeeds.

  • An error code is returned when the request fails.

7BD8F4C7-D84C-4D46-9885-8212997E****

Message

string

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

success

TraceId

string

The returned data.

0bc3b6e215637275918588187d****

Data

object

The ID of the change order.

ChangeOrderId

string

The error code.

  • If the request is successful, this parameter is not returned.****

  • This parameter is returned only if the request failed.**** For more information, see the "Error codes" section in this topic.

4a815998-b468-4bea-b7d8-59f52a44****

ErrorCode

string

The error code returned if the request failed. Take note of the following rules:

  • The ErrorCode parameter is not returned if the request succeeds.

  • If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.

Null

Code

string

The HTTP status code. Take note of the following rules:

  • 2xx: The call was successful.

  • 3xx: The call was redirected.

  • 4xx: The call failed.

  • 5xx: A server error occurred.

200

Success

boolean

Indicates whether the application is created. Valid values

  • true

  • false

true

Examples

Success response

JSON format

{
  "RequestId": "7BD8F4C7-D84C-4D46-9885-8212997E****",
  "Message": "success",
  "TraceId": "0bc3b6e215637275918588187d****",
  "Data": {
    "ChangeOrderId": "4a815998-b468-4bea-b7d8-59f52a44****"
  },
  "ErrorCode": "Null",
  "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 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 Mamespace.Have.No.Applications There are no applications in this namespace. There are no applications in this 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.