Docs
api
Account Management(UAccount)
GetProjectList

Retrieve the project list under the account - GetProjectList

Overview

Get Project List

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetProjectList.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
IsFinancestringIs it a financial account? (Yes: Yes, No: No)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
ProjectCountintTotal Number of ProjectsYes
ProjectSetarray[ProjectListInfo]Instance list of projects in JSON formatYes

Data Model

ProjectListInfo

Field NameTypeDescription InformationRequired
ProjectIdstringProject IDYes
ProjectNamestringProject NameYes
CreateTimeintCreation Time (Unix Timestamp)Yes
IsDefaultbooleanIs it the default project?Yes
ResourceCountintNumber of resources under the project (Deprecated, not recommended for use)Yes
MemberCountintNumber of members in the projectYes
ParentIdstringParent Project ID (Deprecated)No
ParentNamestringParent Project Name (Deprecated)No

Example

Request Example

https://api.dezai.com/?Action=GetProjectList

Response Example

{
  "Action": "GetProjectListResponse",
  "ProjectCount": 2,
  "ProjectSet": [
    {
      "CreateTime": 1342434682,
      "IsDefault": true,
      "MemberCount": 1,
      "ProjectId": "org-1",
      "ProjectName": "ucloud",
      "ResourceCount": 52
    },
    {
      "CreateTime": 1468225814,
      "IsDefault": false,
      "MemberCount": 0,
      "ProjectId": "org-2",
      "ProjectName": "test",
      "ResourceCount": 10
    }
  ],
  "RetCode": 0
}