Tenant Cloud Security Cloud Workload Protection Platform Other APIs DescribeMachineInfoByHashKey

DescribeMachineInfoByHashKey

Last Updated At: 2026-08-02 00:05:03

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to obtain the machine information.

Default interface request rate limit: 20 times per second.

Interface update time: 0001-01-01 00:00:00.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeMachineInfoByHashKey
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
MachineKey No No String Host hashkey.
Example: 539844622

3. Output Parameters

Parameter name Type Description
HostIp String Private Network IP Address
Example: 10.0.0.11
InstanceId String Instance ID
Example: ins-dsdbhjqf
InstanceName String Instance Name
Example: redis_node_cvm
Quuid String Host QUUID
Example: acdd5474-6360-4fd4-bfc7-843162cb8116
Region String Availability zone.
Example: ap-region1
Uuid String Host UUID
Example: acdd5474-6360-4fd4-bfc7-843162cb8116
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InternalError Internal error.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
InvalidParameter Invalid parameter.
OperationDenied Operation denied.
InvalidParameterValue The parameter value is invalid.