Docs
api
Access Control(IAM)
ListProjects

List all projects - ListProjects

Overview

List all projects

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListProjects.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
OffsetstringNo
LimitstringNo

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
Projectsarray[Project]Project InformationYes
TotalCountintTotalYes

Data Model

Project

Field NameTypeDescription InformationRequired
ProjectIDstringProject IDYes
ProjectNamestringProject NameYes
UserCountintNumber of UsersYes
CreatedAtintCreation TimeYes

Example

Request Example

https://api.ucloud-global.com/?Action=ListProjects
&Offset=jNYCtQbd
&Limit=zmvwjdzF

Response Example

{
  "Action": "ListProjectsResponse",
  "Message": "grnIyjqc",
  "Projects": [
    {
      "CreatedAt": 8,
      "ProjectID": "lhxTxRry",
      "ProjectName": "VKDPDmun",
      "UserCount": 7
    }
  ],
  "RetCode": 0,
  "TotalCount": 9
}