Obtain Physical Machine Business Group - DescribePHostTags
Overview
Get physical machine tag list (Business Group)
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribePHostTags . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | No |
ProjectId | string | Project 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 Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
TotalCount | int | Number of Tags | No |
TagSet | array[PHostTagSet] | Refer to PHostTagSet for details | No |
Data Model
PHostTagSet
Field Name | Type | Description Information | Required |
---|---|---|---|
Tag | string | Business Group Name | No |
TotalCount | int | The number of hosts contained in this business group | No |
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
}