tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAgentInstallCommand

Last updated: 2024-08-27 11:41:09

1. API Description

Domain name for API request: cwp.tencentcloudapi.com.

This API is used to obtain the agent installation command.

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: 2018-02-28.
Region No String Common Params. This parameter is not required.
IsCloud Yes Boolean Whether Tencent Cloud
NetType Yes String Network type: basic - basic network; private - VPC; public - public network; direct - direct connect
RegionCode No String Region identifier, required when NetType=direct
VpcId No String VpcId, required when NetType=direct
TagIds.N No Array of Integer Tag ID list, effective only when IsCloud=false
ExpireDate No Date Command validity period, required for non-Tencent Cloud instances
Vip No String VIP Accessed via Proxy Mode

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 of Window installation command (Windows 2003)
WindowsStepTwo String Step 2 of Window installation command (Windows 2003)
WindowsDownloadUrl String Download URL of the agent for Windows
ARMCommand String Arm installation command
Note: This field may return null, indicating that no valid values can be obtained.
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 DescribeAgentInstallCommand

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentInstallCommand
<Common request parameters>

{
    "ExpireDate": "2020-09-22",
    "RegionCode": "xx",
    "VpcId": "xx",
    "IsCloud": true,
    "NetType": "xx",
    "TagIds": [
        1
    ]
}

Output Example

{
    "Response": {
        "WindowsCommand": "xx",
        "LinuxCommand": "xx",
        "ARMCommand": "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
FailedOperation.APIServerFail Failed to invoke the API service.
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy