Queries the commands that are used to manually install the Security Center agent.

Usage notes

You can call the DescribeInstallCodes operation to query the commands that are used to manually install the Security Center agent. The returned results contain the installation verification code and the server information. If you want to manually install the Security Center agent on your server, you can call this operation to query installation commands.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstallCodes

The operation that you want to perform. Set the value to DescribeInstallCodes.

Response parameters

Parameter Type Example Description
RequestId String C0D6119F-92EE-1276-B8B6-C81A7F9D57F5

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

InstallCodes Array of InstallCode

The information about the installation command.

OnlyImage Boolean false

Indicates whether an image is used to install the Security Center agent. Valid values:

  • true: yes
  • false: no
CaptchaCode String 15v02r

The verification code for you to manually install the Security Center agent.

GroupId Long 9165712

The ID of the server group to which the server belongs.

GroupName String Ungrouped

The name of the server group to which the server belongs.

ExpiredDate Long 1637810007000

The timestamp when the installation command expires. Unit: milliseconds.

VendorName String Tencent Cloud

The name of the server provider.

Os String linux

The operating system of the server.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstallCodes
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstallCodesResponse>
    <RequestId>C0D6119F-92EE-1276-B8B6-C81A7F9D57F5</RequestId>
    <InstallCodes>
        <OnlyImage>false</OnlyImage>
        <CaptchaCode>15v02r</CaptchaCode>
        <GroupId>9165712</GroupId>
        <GroupName>Ungrouped</GroupName>
        <ExpiredDate>1637810007000</ExpiredDate>
        <VendorName>Tencent Cloud</VendorName>
        <Os>linux</Os>
    </InstallCodes>
</DescribeInstallCodesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C0D6119F-92EE-1276-B8B6-C81A7F9D57F5",
  "InstallCodes" : [ {
    "OnlyImage" : false,
    "CaptchaCode" : "15v02r",
    "GroupId" : 9165712,
    "GroupName" : "Ungrouped",
    "ExpiredDate" : 1637810007000,
    "VendorName" : "Tencent Cloud",
    "Os" : "linux"
  } ]
}

Error codes

HTTP status code Error code Error message Description
500 ServerError ServerError The error message returned because a server error occurred.

For a list of error codes, visit the API Error Center.