Get project list based on tags - ListProjectsByLabels

Overview

Get project list based on tags

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListProjectsByLabels`.	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
Labels.N.Key	string	Tag Key	Yes
Labels.N.Value	string	Tag Value	Yes

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
Projects	array[ListProjectsByLabelsProject]	Project List	No

Data Model

ListProjectsByLabelsProject

Field Name	Type	Description Information	Required
ProjectId	string	Project ID	Yes
ProjectName	string	Project Name	Yes
ResourceTypes	array[string]	Resource Type List	Yes
DisabledResourceTypes	array[string]	List of Disabled Resource Types	Yes

Example

Request Example

https://api.surfercloud.com/?Action=ListProjectsByLabels
&Labels=kLbYBupR
&Labels.N.Value=hjAbwWLW

Response Example

{
  "Action": "ListProjectsByLabelsResponse",
  "Projects": [
    {
      "DisabledResourceTypes": [
        "yKfWEIAu"
      ],
      "ProjectId": "NeWtqvDg",
      "ProjectName": "guFElyPP",
      "ResourceTypes": [
        "VMPZwwHe"
      ]
    }
  ],
  "RetCode": 0
}

ListLabelsByResourceIds ListResourcesByLabels