Docs
api
UHost(UHost)
DescribeUHostTags

Get Host Business Group List - DescribeUHostTags

Overview

Get the business group list of the specified data center.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUHostTags.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, sub-accounts 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
TotalCountintTotal number of business groups with existing hostsNo
TagSetarray[UHostTagSet]See UHostTagSet for business group collectionNo

Data Model

UHostTagSet

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

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeUHostTags
&Region=cn-bj2
&Zone=cn-bj2-04
&ProjectId=org-xxx

Response Example

{
  "Action": "DescribeUHostTagsResponse",
  "RetCode": 0,
  "TagSet": [
    {
      "Tag": "Default",
      "TotalCount": 2,
      "Zone": "xxx"
    }
  ],
  "TotalCount": 1
}