docs
api
Physical Cloud Host(UPHost)
DescribePHostTags

Obtain Physical Machine Business Group - DescribePHostTags

Overview

Get physical machine tag list (Business Group)

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribePHostTags.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintNumber of TagsNo
TagSetarray[PHostTagSet]Refer to PHostTagSet for detailsNo

Data Model

PHostTagSet

Field NameTypeDescription InformationRequired
TagstringBusiness Group NameNo
TotalCountintThe number of hosts contained in this business groupNo

Example

Request Example

https://api.surfercloud.com/?Action=DescribePHostTags
&Region=CWMTvjLZ
&Zone=QklvvNAh
&ProjectId=jEMWaxuP

Response Example

{
  "Action": "DescribePHostTagsResponse",
  "RetCode": 0,
  "TagSet": [
    {
      "Tag": "CExGsyPK",
      "TotalCount": 2
    }
  ],
  "TotalCount": 2
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved