All Products
Search
Document Center

Simple Application Server:DescribeSecurityAgentStatus

Last Updated:Apr 17, 2024

Queries the status of the Security Center agent on a simple application server.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
InstanceIdstringYes

The ID of the simple application server.

ace0706b2ac4454d984295a94213****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
ClientStatusstring

The status of the Security Center agent. Valid values:

  • pause: The Security Center agent suspends protection for your server.
  • online: The Security Center agent is protecting your server.
  • offline: The Security Center agent does not protect your server.
online

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "ClientStatus": "online"
}

Error codes

HTTP status codeError codeError message
500InternalErrorAn error occurred while processing your request.

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