All Products
Search
Document Center

:BatchStopApplications

Last Updated:Aug 01, 2024

Stops multiple applications at a time.

Debugging

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

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:BatchStopApplicationsnone
  • All Resources
    *
    none
none

Request syntax

PUT /pop/v1/sam/app/batchStopApplications

Request parameters

ParameterTypeRequiredDescriptionExample
NamespaceIdstringYes

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

cn-shanghai
AppIdsstringNo

The ID of the request.

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

The application version.

1.0

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The returned message.

  • success is returned when the request succeeds.
  • An error code is returned when the request fails.
7BD8F4C7-D84C-4D46-9885-8212997E****
Messagestring

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

success
TraceIdstring

The returned data.

0bc3b6e215637275918588187d****
Dataobject

The ID of the change order.

ChangeOrderIdstring

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****
ErrorCodestring

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
Codestring

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
Successboolean

Indicates whether the application is created. Valid values

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400System.UpgradingThe system is being upgraded. Please try again later.-
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.-
400Invalid.App.List.Not.Same.NamespaceThe selected applications do not belong to the same namespace.The selected applications does not belong to the same namespace.
400Mamespace.Have.No.ApplicationsThere are no applications in this namespace.There are no applications in this namespace.
400user.indebtThe user has an outstanding payment.-

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

Change history

Change timeSummary of changesOperation
2024-04-12The Error code has changed. The request parameters of the API has changedView Change Details