tencent cloud

DescribeAgentInstallCommand
最后更新时间：2024-12-06 15:50:41
DescribeAgentInstallCommand
最后更新时间： 2024-12-06 15:50:41

1. API Description

Domain name for API request: tcss.intl.tencentcloudapi.com.

This API is used to query agent installation commands.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAgentInstallCommand.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
IsCloud Yes Boolean Whether it is from Tencent Cloud
NetType Yes String Network type. Valid values: basic (classic network); private (VPC); public (public network); direct (Direct Connect).
RegionCode No String Region, which is required when NetType is direct.
VpcId No String VpcId, which is required when NetType is direct.
ExpireDate No String Command validity, which is required for non-Tencent Cloud instances.
TagIds.N No Array of Integer Tag ID list, which is valid only when IsCloud is false.

3. Output Parameters

Parameter Name Type Description
LinuxCommand String Linux installation command
WindowsCommand String Windows installation command (Windows 2008 or later)
WindowsStepOne String Step 1 in the Window installation command (Windows 2003)
WindowsStepTwo String Step 2 in the Window installation command (Windows 2003)
WindowsDownloadUrl String Download URL of the agent for Windows
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying agent installation commands

Input Example

https://tcss.intl.tencentcloudapi.com/?Action=DescribeAgentInstallCommand
&IsCloud=true
&NetType="basic"
&<Common request parameters>

Output Example

{
    "Response": {
        "WindowsCommand": "xx",
        "LinuxCommand": "xx",
        "WindowsDownloadUrl": "xx",
        "RequestId": "xx",
        "WindowsStepOne": "xx",
        "WindowsStepTwo": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure A CAM signature/authentication error occurred.
FailedOperation The operation failed.
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidFormat The parameter format is incorrect.
InvalidParameter.MissingParameter The required parameter is missing.
InvalidParameter.ParsingError A parameter parsing error occurred.
InvalidParameterValue The parameter value is incorrect.
MissingParameter The parameter is missing.
ResourceNotFound The resource does not exist.
UnknownParameter The parameter is unknown.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈