Data structure

Last Updated At: 2026-08-02 00:04:24

Region

Region

Referenced by the following interfaces: DescribeResourceRegions

name required NULL allowed type description
RegionId yes no Uint64 Region ID
Example: 5000001
RegionName yes no String Region name.
Example: region1

ApplyProjectQuotaHistory

Project quota application history

Referenced by the following interfaces: DescribeApplyProjectQuotaHistory

name required NULL allowed type description
PaperID yes no Uint64 Approval form ID
Example: 1
ApplicantUin yes no String Applicant UIN
Example: 1000
Applicant yes no String Applicant
Example: admin
CTime yes no String Application time
Example: 2014-10-09T14:43:49+08:00
QuotaKey yes no String Quota key
Example: p_cvm###
QuotaName yes no String Quota name
Example: CVM
QuotaValue yes no Uint64 Quota quantity
Example: 1000
ApplyQuotaValue yes no Uint64 Requested quota quantity
Example: 100
Status yes no Uint64 Approval Status
Example: 14

Resource

Resource Type

Referenced by the following interfaces: DescribeProducts

name required NULL allowed type description
ProductCode yes no String Product ID
Example: p_cvm
ResourceType yes no String Resource type.
Example: volume
ServiceType yes no String Service type, corresponding to CAM serviceType
Example: cvm

Project

Project

Referenced by the following interfaces: DescribeProjects

name required NULL allowed type description
ProjectId yes no String Project ID
Example: pr-dcd34c11
ProjectName yes no String Project Name
Example: pr1
Organization yes no String Organization
Example: org1
Creator yes no String Created By
Example: admin
CreateTime yes no Datetime Creation time.
Example: 2014-08-03 12:00:00
CreatorUin yes no Uint64 Creator UIN.
Example: 1000
OrgId yes no String Organization ID.
Example: org-231
OrgName yes no String Organization Name
Example: org1
OrgOperationTime yes no String Time when a project is included in a project directory. 
Example: 2014-08-03 12:00:00
OrgOperator yes no String Operator who includes a project in a project directory. 
Example: admin
ProjectDescription no no String Project description
Example: desc
Uin no no String User ID
Example: 100
AppId no no Uint64 AppId
Example: 100

QuotaNames

Product name.

Referenced by the following interfaces: CheckProjectQuotas

name required NULL allowed type description
ProductName yes no String Name of a level-1 product.
Example: cvm
SubProductName no no String Name of a level-2 product.
Example: SSD Cloud Disk
BillingItemName no no String Name of a level-3 product.
Example: Storage Space
SubBillingItemName no no String Name of a level-4 product.
Example: SSD cloud disk - storage space.

TransferResource

Resource transfer.

Referenced by the following interfaces: AddProjectResource, DeleteProjectResource, MoveProjectResource

name required NULL allowed type description
ProductCode yes no String Product Code
Example: p_cvm
RegionId yes no String Region ID
Example: 500001
ResourceId yes no String Resource ID.
Example: ins-abzttwhl
Uin no no String User UIN.
Example: 1000
Region no no String Region
Example: region1

Product

Product.

Referenced by the following interfaces: DescribeProductTree

name required NULL allowed type description
ProductCode yes no String Product ID
Example: p_cvm
ProductName yes no String Product name.
Example: cvm
Unit yes no String Unit
Example: 1

PolicyFilter

Policy

Referenced by the following interfaces: DescribeProjectMemberPolicies, DescribeProjectPolicies

name required NULL allowed type description
Keyword no no String Policy name that serves as a fuzzy query condition.
Example: 1

QuotaChecking

Quota verification result

Referenced by the following interfaces: CheckProjectQuotas

name required NULL allowed type description
BillingItemCode yes no String Level-3 product.
Example: v_cvm_cpu
BillingItemName yes no String Product item
Example: Storage Space
Error yes no String Error Content
Example: operation error
Exists yes no Bool Whether there is a quota. true: yes; false: no.
Example: true
ProductCode yes no String Product Code
Example: p_cvm
ProductName yes no String Product name.
Example: cvm
QuotaKey yes no String Quota key.
Example: p_cvm###
QuotaLeft yes no String The remaining quota.
Example: 100
QuotaUsed yes no String Used Quota
Example: 100
QuotaValue yes no String Quota
Example: 100
SubBillingItemCode yes no String Level-4 product.
Example: sv_cbs_memspace_common
SubBillingItemName yes no String Product details
Example: SSD cloud disk - storage space.
SubProductCode yes no String Level-2 product.
Example: sp_cvm_sh1
SubProductName yes no String Sub-product name
Example: SSD Cloud Disk
Success yes no Bool Whether it is valid. 1: yes; 0: no,
Example: true

ProjectMemberFilter

Query.

Referenced by the following interfaces: DescribeProjectMembers, DescribeProjectNonMembers

name required NULL allowed type description
Keyword no no String User ID or user name that serves as a fuzzy search condition.
Example: ""

ProjectResource

Project Resources

Referenced by the following interfaces: DescribeProjectResources, DescribeResources

name required NULL allowed type description
ProjectId yes no String Project ID
Example: pr-dcd34c11
ResourceId yes no String Resource ID.
Example: ins-abzttwhl
ResourceName yes no String Resource Name
Example: cvm
ProductCode yes no String Product ID
Example: p_cvm
ProductName yes no String Product name.
Example: cvm
ProductGroupName yes no String Product category name.
Example: cvm
RegionId yes no Int64 Region ID
Example: 5000001
ProjectName yes no String Project Name
Example: pr1
RegionEnName yes no String English name of the region.
Example: region1
RegionName yes no String Region name.
Example: region1
ResourceType yes no String Resource type.
Example: cvm
ServiceType yes no String Service type that corresponds to a product.
Example: cvm
Product no no String Product name.
Example: cvm
Uin no no Uint64 User ID
Example: 100

Policy

Policy

Referenced by the following interfaces: DescribeProjectMemberPolicies, DescribeProjectMembers, DescribeProjectNonMembers, DescribeProjectPolicies

name required NULL allowed type description
PolicyName yes no String Policy name.
Example: policygen-20141112201913
Description yes no String Policy description.
Example: desc
PolicyId no no Uint64 Policy ID.
Example: 1000

ProjectMember

Project Members

Referenced by the following interfaces: DescribeProjectMembers, DescribeProjectNonMembers

name required NULL allowed type description
Uin yes no Uint64 User UIN.
Example: 1000
Uid yes no Uint64 User UID.
Example: 1000
Name yes no String User Name
Example: member1
Policies yes yes Array of Policy Associated policies.
Example:View

ProjectQuota

Project quota.

Referenced by the following interfaces: DescribeProjectQuotas

name required NULL allowed type description
ProjectId yes no String Project ID
Example: pr-dcd34c11
ProductName yes no String Product name.
Example: cvm
ProductCode yes no String Product ID
Example: p_cvm
SubProductCode yes yes String Level-2 product.
Example: sp_cvm_sh1
BillingItemCode yes yes String Level-3 product.
Example: v_cvm_cpu
SubBillingItemCode yes yes String Level-4 product.
Example: sv_cbs_memspace_common
QuotaKey yes no String Quota key.
Example: p_cvm###
QuotaName yes yes String Quota Item Name
Example: CloudDB for Redis
QuotaValue yes no String Total Quota
Example: 100
QuotaLeft yes no Int64 The remaining quota.
Example: 100
QuotaUsed yes no Int64 Used Quota
Example: 100
CreateTime yes no String Creation time.
Example: 2014-08-03 12:00:00
UpdateTime yes no String Update time.
Example: 2014-08-03 12:00:00
BillingItemName yes no String Product item
Example: Storage Space
SubBillingItemName yes no String Product details
Example: SSD cloud disk - storage space.
SubProductName yes no String Sub-product name
Example: SSD Cloud Disk
Unit yes no String Unit
Example: 1

ResourceAdminProject

Project

Referenced by the following interfaces: DescribeResourceAdminProjects

name required NULL allowed type description
ProjectId yes no String Project ID
Example: pr-dcd34c11
ProjectName yes no String Project Name
Example: pro1
Organization yes no String Project name.
Example: org1

AddQuota

Added quota.

Referenced by the following interfaces: BatchAddProjectQuota

name required NULL allowed type description
ProductCode yes no String Code of a level-1 product.
Example: p_cvm
SubProductCode no no String Code of a level-2 product.
Example: sp_cvm_sh1
BillingItemCode no no String Code of a level-3 product.
Example: v_cvm_cpu
SubBillingItemCode no no String Code of a level-4 product.
Example: sv_cbs_memspace_common
QuotaValue yes no Int64 Quota
Example: 100
QuotaKey no no String Quota key.
Example: p_cvm###

Products

Product.

Referenced by the following interfaces: DescribeProducts

name required NULL allowed type description
ProductName yes no String Product name
Example: cvm
ResourceTypes yes no Array of Resource Resource type.
Example:View

UinPolicy

Policy associated with the user with a UIN.

Referenced by the following interfaces: AddProjectMemberPolicy

name required NULL allowed type description
Uin yes no Uint64 Account ID
Example: 1000
PolicyName yes no String Policy name.
Example: policygen-20141112201913

DescribeProjectsFilter

API for querying list search conditions for a project

Referenced by the following interfaces: DescribeProjects

name required NULL allowed type description
Keyword no no String Project ID or project name that serves as a fuzzy search condition.
Example: ""
Type no no Uint64 Match type
Example: 1

ProjectQuotaFilter

Quota query conditions.

Referenced by the following interfaces: DescribeProjectQuotas

name required NULL allowed type description
ProductCode yes no String Level-1 product.
Example: p_cvm
SubProductCode no no String Level-2 product.
Example: sp_cvm_sh1
BillingItemCode no no String Level-3 product.
Example: v_cvm_cpu
SubBillingItemCode no no String Level-4 product.
Example: sv_cbs_memspace_common
Keyword no no String Quota item name that serves as a fuzzy query condition.
Example: cvm

ProjectResourceFilter

Conditions for a resource list search.

Referenced by the following interfaces: DescribeProjectResources

name required NULL allowed type description
ResourceId no no String Resource ID.
Example: ins-abzttwhl
RegionId no no Uint64 Region
Example: 5000001
ProductCode no no String Product ID
Example: p_cvm
ResourceType no no String Resource type. This parameter is not supported.
Example: cvm
Keyword no no String Resource ID or resource name that serves as a fuzzy search condition.
Example: ins-dsad12
Product no no String Product ID
Example: p_cvm
ServiceType no no String Service Type
Example: cvm

DeleteQuota

API for deleting a quota.

Referenced by the following interfaces: DeleteProjectQuota

name required NULL allowed type description
ProductCode yes no String Product ID
Example: p_cvm
QuotaKey yes no String Quota key.
Example: p_cvm###