tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetHostDetail

Last updated: 2024-12-06 15:48:40

    1. API Description

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

    This API is used to query the details of a server.

    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: DescribeAssetHostDetail.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    HostId Yes String Server ID

    3. Output Parameters

    Parameter Name Type Description
    UUID String TCSS UUID
    UpdateTime String Update time
    HostName String Server name
    Group String Server group
    HostIP String Server IP
    OsName String OS
    AgentVersion String Agent version
    KernelVersion String Kernel version
    DockerVersion String Docker version
    DockerAPIVersion String Docker API version
    DockerGoVersion String Docker version for Go
    DockerFileSystemDriver String Docker file system type
    DockerRootDir String Docker root directory
    ImageCnt Integer Number of images
    ContainerCnt Integer Number of containers
    K8sMasterIP String K8s IP
    K8sVersion String K8s version
    KubeProxyVersion String kube proxy
    Status String Valid values: UNINSTALL (not installed); OFFLINE (offline); ONLINE (defended).
    IsContainerd Boolean Whether it is Containerd
    MachineType String Server source. Valid values: TENCENTCLOUD (Tencent Cloud instance); OTHERCLOUD (non-Tencent Cloud instance).
    PublicIp String Public IP
    InstanceID String Server instance ID
    RegionID Integer Region ID
    Project ProjectInfo Project
    Tags Array of TagInfo Tags
    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 the details of a server

    The following example shows how to query the details of a server.

    Input Example

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

{
    "HostId": "dskaldjskld"
}

    Output Example

    {
    "Response": {
        "UUID": "abc",
        "UpdateTime": "abc",
        "HostName": "abc",
        "Group": "abc",
        "HostIP": "abc",
        "OsName": "abc",
        "AgentVersion": "abc",
        "KernelVersion": "abc",
        "DockerVersion": "abc",
        "DockerAPIVersion": "abc",
        "DockerGoVersion": "abc",
        "DockerFileSystemDriver": "abc",
        "DockerRootDir": "abc",
        "ImageCnt": 1,
        "ContainerCnt": 1,
        "K8sMasterIP": "abc",
        "K8sVersion": "abc",
        "KubeProxyVersion": "abc",
        "Status": "abc",
        "IsContainerd": true,
        "MachineType": "abc",
        "PublicIp": "abc",
        "InstanceID": "abc",
        "RegionID": 0,
        "Project": {
            "ProjectName": "abc",
            "ProjectID": 0
        },
        "Tags": [
            {
                "TagKey": "abc",
                "TagValue": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy