All Products
Search
Document Center

Security Center:OperateAgentClientInstall

Last Updated:Nov 25, 2024

Installs the Security Center agent on servers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-sas:OperateAgentClientInstallnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsstringNo

The IDs of the servers on which you want to install the Security Center agent. Separate multiple IDs with commas (,).

Note : You must specify at least one of InstanceIds and Uuids. If you specify InstanceIds, you must also specify Region and Os.
i-uf6j8vq9l4r5ntht****
UuidsstringNo

The UUIDs of the servers on which you want to install the Security Center agent. Separate multiple UUIDs with commas (,).

Note You must specify at least one of the InstanceIds and Uuids parameters before you can call this operation.
1587bedb-fdb4-48c4-9330-************
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
en
RegionstringNo

The region where the servers reside. Valid values include the following regions:

  • cn-hangzhou: China (Hangzhou)
  • cn-beijing: China (Beijing)
  • cn-shanghai: China (Shanghai)
  • cn-zhangjiakou: China (Zhangjiakou)
  • cn-shenzhen: China (Shenzhen)
cn-hangzhou
OsstringNo

The operating system of the servers. Valid values:

  • linux
  • windows
linux

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

AE79B457-877C-51C6-AD72-0D34A025D***
AegisCelintInstallResposeListarray<object>

An array that consists of the returned results.

AegisCelintInstallResposeobject

The details of the returned results.

Uuidstring

The UUID of the server.

1587bedb-fdb4-48c4-9330-****
InstanceIdstring

The ID of the server.

i-uf6j8vq9l4r5ntht****
RecordIdlong

The ID of the installation task.

2856

Examples

Sample success responses

JSONformat

{
  "RequestId": "AE79B457-877C-51C6-AD72-0D34A025D***",
  "AegisCelintInstallResposeList": [
    {
      "Uuid": "1587bedb-fdb4-48c4-9330-****",
      "InstanceId": "i-uf6j8vq9l4r5ntht****",
      "RecordId": 2856
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500InternalErrorThe request processing has failed due to some unknown error.-
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2023-08-29The Error code has changedView Change Details
2023-06-05The Error code has changed. The request parameters of the API has changedView Change Details
2022-12-19API Description Update. The Error code has changedView Change Details
2022-08-01The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-08-01The internal configuration of the API is changed, but the call is not affectedView Change Details