tencent cloud

All product documents
APIs
Data Types
Last updated: 2025-02-08 11:32:42
Data Types
Last updated: 2025-02-08 11:32:42

ApprovalItem

Result of the mini program approval requests

Used by actions: ProcessMNPApproval.

Name Type Required Description
AppId String Yes Application ID
ApprovalResult Integer Yes Approval result. 2: Rejected;
3: Approved
ApprovalNote String No Approval notes. It’s required when the request is rejected.

BooleanInfo

Used for Data object when no data is returned after the a successful action.

Used by actions: AddTeamMember, ConfigureMNPPreview, CreateApplicationSensitiveAPI, CreateMNPApproval, CreateMNPDomainACL, DeleteApplication, DeleteApplicationSensitiveAPI, DeleteMNP, DeleteTeam, DeleteTeamMember, DeleteUser, DisableApplicationSensitiveAPI, EnableApplicationSensitiveAPI, ModifyApplication, ModifyMNPDomain, ModifyTeam, ModifyTeamMember, ModifyUser, ProcessMNPApproval, ProcessMNPSensitiveAPIPermissionApproval, ReleaseMNPVersion, RemoveMNP, RollbackMNPVersion.

Name Type Description
Result Boolean Bool type response object
Note: This field may return null, indicating that no valid values can be obtained.

CreateApplicationSensitiveAPIReq

The request to add a sensitive API

Used by actions: CreateApplicationSensitiveAPI.

Name Type Required Description
APIName String No API name
Note: This field may return null, indicating that no valid values can be obtained.
APIDesc String No API description
Note: This field may return null, indicating that no valid values can be obtained.
APIType Integer No API type. 1: System; 2: Custom
Note: This field may return null, indicating that no valid values can be obtained.

CreateDomainParam

Parameters to create a domain name

Used by actions: CreateMNPDomainACL, ModifyMNPDomain.

Name Type Required Description
DomainUrlList Array of String Yes Array of domain name URLs
DomainType Integer Yes Domain type. 1: requests domain; 2: WebView load domain, 3: sockets domain; 4: File upload; 5: File download

CreateGlobalDomainResp

Response of creating a global domain name

Used by actions: CreateGlobalDomainACL.

Name Type Description
Result Boolean Result
Note: This field may return null, indicating that no valid values can be obtained.
RepeatUrls Array of String List of duplicate domain names
Note: This field may return null, indicating that no valid values can be obtained.
ExistsWhiteUrls Array of String List of allowed domain names
Note: This field may return null, indicating that no valid values can be obtained.
ExistsBlackUrls Array of String List of blocked domain names
Note: This field may return null, indicating that no valid values can be obtained.

CreateMNPVersionResp

Response of creating a mini program version

Used by actions: CreateMNPVersion.

Name Type Required Description
TaskId String No ID of the task to create a mini program version
Note: This field may return null, indicating that no valid values can be obtained.

CreateTeamMemberInfoReq

New team member - Member information

Used by actions: AddTeamMember.

Name Type Required Description
UserId String No User ID
UserRoleId Integer No User role ID

DescribeApplicationListData

Application information

Used by actions: DescribeApplicationList.

Name Type Description
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
AppIdentityId Integer App ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Name
Note: This field may return null, indicating that no valid values can be obtained.
Logo String Icon
Remark String Remarks
AndroidAppKey String Android app package name
Note: This field may return null, indicating that no valid values can be obtained.
IosAppKey String iOS App bundleId
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateUser String Updater
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.
Intro String Introduction
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
SensitiveApiCount Integer Number of sensitive APIs
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationType Integer Application type. 1: Test; 2: Formal
Note: This field may return null, indicating that no valid values can be obtained.

DescribeApplicationListResp

List of applications

Used by actions: DescribeApplicationList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeApplicationListData List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeApplicationResp

Application details

Used by actions: DescribeApplication.

Name Type Description
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
AppIdentityId Integer Product ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
Logo String Application icon
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: This field may return null, indicating that no valid values can be obtained.
AndroidAppKey String Android package name
Note: This field may return null, indicating that no valid values can be obtained.
IosAppKey String iOS bundleId
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateUser String Updater
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.
Intro String Application description
Note: This field may return null, indicating that no valid values can be obtained.
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
SensitiveApiCount Integer Number of sensitive APIs
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationType Integer Application type. 1: Test; 2: Formal
Note: This field may return null, indicating that no valid values can be obtained.

DescribeApplicationSensitiveAPIListData

List of sensitive APIs of an application

Used by actions: DescribeApplicationSensitiveAPIList.

Name Type Description
APIId String APIID
APIName String API name
APIMethod String API request method
APIDesc String API description
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
CreateTime String Creation time
UpdateUser String Updater
UpdateTime String Update time
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationLogo String Application icon
Note: This field may return null, indicating that no valid values can be obtained.
APIType Integer API type. 1: System; 2: Custom
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer API status. 0: Public; 1: Restricted
Note: This field may return null, indicating that no valid values can be obtained.

DescribeApplicationSensitiveAPIListResp

List of sensitive APIs of the application

Used by actions: DescribeApplicationSensitiveAPIList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeApplicationSensitiveAPIListData List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeDomainInfoParam

Domain information

Used by actions: DescribeMNPDomainACL.

Name Type Description
DomainUrl String Multiple domain separators ';'
Note: This field may return null, indicating that no valid values can be obtained.
DomainType Integer Domain type 1-requests domain 2-WebView load domain
Note: This field may return null, indicating that no valid values can be obtained.

DescribeGlobalDomainsListData

List of global domain names

Used by actions: DescribeGlobalDomainACL.

Name Type Description
DomainId Integer Domain ID
Note: This field may return null, indicating that no valid values can be obtained.
DomainUrl String Domain name
Note: This field may return null, indicating that no valid values can be obtained.
DomainType Integer Type. 1: Allowed; 2: Blocked
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateUser String Updater
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.

DescribeGlobalDomainsResp

Global domain name page list

Used by actions: DescribeGlobalDomainACL.

Name Type Description
TotalCount Integer Total number of results
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeGlobalDomainsListData Domain name information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPApprovalListData

List of mini program approval requests of the application

Used by actions: DescribeMNPApprovalList.

Name Type Description
ApprovalNo String Approval request ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalStatus Integer Approval status : 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled
Note: This field may return null, indicating that no valid values can be obtained.
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersion String Mini program version
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionId Integer Mini program version ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplyUser String Applicant
Note: This field may return null, indicating that no valid values can be obtained.
ApplyTime String Application time
Note: This field may return null, indicating that no valid values can be obtained.
MNPName String Mini program name
Note: This field may return null, indicating that no valid values can be obtained.
MNPIcon String Mini program icon
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationLogo String Application icon
Note: This field may return null, indicating that no valid values can be obtained.
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
MNPQrCodeUrl String Mini Program QR code
Note: This field may return null, indicating that no valid values can be obtained.
MNPType String Mini program type
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalUser String Approver
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalTime String Approval time
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalNote String Approval notes
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPApprovalListResp

List of mini program approval requests of an application

Used by actions: DescribeMNPApprovalList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeMNPApprovalListData List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPListData

Mini program list

Used by actions: DescribeMNPList.

Name Type Description
MNPId String Mini program ID
MNPIcon String Mini program icon
MNPName String Mini program name
TeamName String Name of the associated team
MNPType String Mini program type
Status Integer Whether the mini program is released. 1: Released; 2: Removed
Note: This field may return null, indicating that no valid values can be obtained.
MNPIntro String Mini program introduction
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateUser String Updater
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
EffectStatus Integer Effective status of the bound application. 1: Not effective; 2: Effective
Note: This field may return null, indicating that no valid values can be obtained.
EffectMNPVersionId Integer ID of the application bound with the mini program
Note: This field may return null, indicating that no valid values can be obtained.
EffectMNPVersion String Effective version number of the application that bound with the mini program
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPListResp

Mini program list

Used by actions: DescribeMNPList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeMNPListData List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPManagerDetailData

Mini program details

Used by actions: DescribeMNP.

Name Type Description
MNPType String Mini program type
Note: This field may return null, indicating that no valid values can be obtained.
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPName String Mini program name
Note: This field may return null, indicating that no valid values can be obtained.
MNPIcon String Mini program icon
Note: This field may return null, indicating that no valid values can be obtained.
MNPIntro String Mini program introduction
Note: This field may return null, indicating that no valid values can be obtained.
MNPDesc String Mini program description
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time, timestamp
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
AccessStatus Integer Connection status. 1: Not connected; 2: Connected
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String The name of the associated team
Note: This field may return null, indicating that no valid values can be obtained.
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Mini program release status. 1: Released; 2: Removed
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPPreviewResp

Response of querying the preview

Used by actions: DescribeMNPPreview.

Name Type Description
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPName String Mini program name
Note: This field may return null, indicating that no valid values can be obtained.
MNPDesc String Mini program description
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersion String Mini program version
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionIntro String Mini program introduction
Note: This field may return null, indicating that no valid values can be obtained.
QRCodeUrl String Mini program QR code
Note: This field may return null, indicating that no valid values can be obtained.
PreviewEntrancePath String Path to the preview
Note: This field may return null, indicating that no valid values can be obtained.
QRCodeContent String QR code content
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPSensitiveAPIPermissionApprovalData

Details of a permission request to allow a mini program to call sensitive APIs

Used by actions: DescribeMNPSensitiveAPIPermissionApproval.

Name Type Description
APIId String API ID
Note: This field may return null, indicating that no valid values can be obtained.
APIMethod String API request method
Note: This field may return null, indicating that no valid values can be obtained.
ApplyReason String Reason for the request
Note: This field may return null, indicating that no valid values can be obtained.
RejectReason String Reason for rejection
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalStatus Integer Approval status. 20: Rejected; 30: Approved
Note: This field may return null, indicating that no valid values can be obtained.
APIDesc String API feature description
Note: This field may return null, indicating that no valid values can be obtained.
APIType Integer API type. 1: System; 2: Custom
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPSensitiveAPIPermissionApprovalListData

List of permission requests to allow a mini program to call sensitive APIs

Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.

Name Type Description
ApprovalNo String Approval ID
APIId String Sensitive API ID
APIName String API name
APIMethod String API request method
MNPId String Mini program ID
MNPName String Mini program name
ApplyUser String Applicant
ApplyTime String Application time
ApplyNote String Application notes
ApprovalStatus Integer Approval status. 1: Processing; 20: Rejected; 30: Approved
ApprovalUser String Approver
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalTime String Approval time
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalNote String Approval notes
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationLogo String Application icon
Note: This field may return null, indicating that no valid values can be obtained.
APIType Integer API type. 1: System; 2: Custom
Note: This field may return null, indicating that no valid values can be obtained.
APIDesc String API feature description
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPSensitiveAPIPermissionApprovalListResp

List of permission requests to allow a mini program to call sensitive APIs

Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.

Name Type Description
TotalCount Integer Total number of entries
DataList Array of DescribeMNPSensitiveAPIPermissionApprovalListData List information

DescribeMNPSensitiveAPIPermissionListData

List of sensitive APIs that can be called by a mini program

Used by actions: DescribeMNPSensitiveAPIPermissionList.

Name Type Description
APIId String API ID
Note: This field may return null, indicating that no valid values can be obtained.
APIName String API name
Note: This field may return null, indicating that no valid values can be obtained.
APIMethod String API request method
Note: This field may return null, indicating that no valid values can be obtained.
APIStatus Integer API status
Note: This field may return null, indicating that no valid values can be obtained.
APIApplyStatus Integer API application status
Note: This field may return null, indicating that no valid values can be obtained.
RejectReason String Reason for rejection
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalNo String Approval ID
ApplicationId String Application ID
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationIcon String Application icon
Note: This field may return null, indicating that no valid values can be obtained.
ApplicationName String Application name
Note: This field may return null, indicating that no valid values can be obtained.
APIType Integer API type. 1: System; 2: Custom
Note: This field may return null, indicating that no valid values can be obtained.
APIDesc String API feature description
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPSensitiveAPIPermissionListResp

List of sensitive APIs that can be called by a mini program

Used by actions: DescribeMNPSensitiveAPIPermissionList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeMNPSensitiveAPIPermissionListData List data
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMNPVersionResp

Result of the task to create a mini program version

Used by actions: DescribeMNPVersion.

Name Type Description
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
TaskId String Task ID
Note: This field may return null, indicating that no valid values can be obtained.
TaskStatus Integer 1: Pending; 20: Running; 30: Failed; 60: Succeeded
Note: This field may return null, indicating that no valid values can be obtained.
TaskMsg String Task status message
Note: This field may return null, indicating that no valid values can be obtained.

DescribeMPAllStageVersionsResp

List of all developer versions of a mini program

Used by actions: DescribeMNPAllStageVersions.

Name Type Description
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionId Integer Mini program version ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPName String Mini program name
Note: This field may return null, indicating that no valid values can be obtained.
MNPIcon String Mini program icon
Note: This field may return null, indicating that no valid values can be obtained.
MNPType String Mini program type
Note: This field may return null, indicating that no valid values can be obtained.
MNPIntro String Mini program introduction
Note: This field may return null, indicating that no valid values can be obtained.
MNPDesc String Mini program description
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Developer
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String The time when the developer created it
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersion String Mini program version
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionIntro String Version features
Note: This field may return null, indicating that no valid values can be obtained.
Phase String Phase. Values: [Develop,Platform,Online]
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalStatus Integer 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled
Note: This field may return null, indicating that no valid values can be obtained.
ApprovalNo String Approval request number
Note: This field may return null, indicating that no valid values can be obtained.
ShowCase Integer Whether it is a preview
0: Not a preview; 1: Preview
Note: This field may return null, indicating that no valid values can be obtained.
RollbackVersion Integer Version number to roll back to
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Release status
Note: This field may return null, indicating that no valid values can be obtained.
VersionCurrentStatus Integer Version approval status. 0: Pending; 1: Processing; 2: Rejected; 3: Approved; 4: Cancelled
Note: This field may return null, indicating that no valid values can be obtained.

DescribeRevertOnlineVersionPageResp

Response of querying the rollback version list

Used by actions: DescribeMNPReleasedVersionHistory.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of QueryOnlineVersionResp List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeRoleListData

Role management list

Used by actions: DescribeRoleList.

Name Type Description
RoleId Integer Role ID
Note: This field may return null, indicating that no valid values can be obtained.
RoleName String Role name
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
RoleType Integer Role type 1-Preset role 2-Custom role
Note: This field may return null, indicating that no valid values can be obtained.

DescribeRoleListResp

Role management list

Used by actions: DescribeRoleList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeRoleListData List data
Note: This field may return null, indicating that no valid values can be obtained.

DescribeTeamDetailResp

Team details

Used by actions: DescribeTeam.

Name Type Description
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
TeamRoleType Integer Team role type 1-Mini program team 2-Application team
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserAccount String Admin account
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String Creator
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
MemberCount Integer Number of team members
Note: This field may return null, indicating that no valid values can be obtained.
BindMiniTeamCount Integer Number of bound mini program teams
Note: This field may return null, indicating that no valid values can be obtained.
BindTeamName String Name of the bound team
RegisterLink String Team registration link
ApplicationName String Application name. It’s required when querying details of a mini program team.

DescribeTeamListInfoResp

Team list information

Used by actions: DescribeTeamList.

Name Type Description
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserId String Admin ID
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserAccount String Admin account
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserName String Admin username
Note: This field may return null, indicating that no valid values can be obtained.
MemberCount Integer Number of team members
Note: This field may return null, indicating that no valid values can be obtained.
RegisterLink String Team registration link
TeamRoleTypeList Array of Integer Team permission type
Note: This field may return null, indicating that no valid values can be obtained.
RelatedTeamId Integer Associated team ID

DescribeTeamMemberInfoResp

Team member information

Used by actions: DescribeTeamMemberList.

Name Type Description
UserId String User ID
Note: This field may return null, indicating that no valid values can be obtained.
UserAccount String User account
Note: This field may return null, indicating that no valid values can be obtained.
UserName String User name
Note: This field may return null, indicating that no valid values can be obtained.
TeamId String Team ID
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.
TeamRoleName String Team role name
Note: This field may return null, indicating that no valid values can be obtained.
TeamRoleId Integer Team role ID
Note: This field may return null, indicating that no valid values can be obtained.
CanEdit Boolean Editable or not
Note: This field may return null, indicating that no valid values can be obtained.

DescribeTeamMemberListPageResp

List of members

Used by actions: DescribeTeamMemberList.

Name Type Description
TotalCount Integer Total number of results.
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeTeamMemberInfoResp List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeTeamPageResp

Team list

Used by actions: DescribeTeamList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeTeamListInfoResp List information
Note: This field may return null, indicating that no valid values can be obtained.

DescribeUserDetailResp

User details

Used by actions: DescribeUser.

Name Type Description
UserId String User ID
Note: This field may return null, indicating that no valid values can be obtained.
UserAccount String User account
Note: This field may return null, indicating that no valid values can be obtained.
AccountType Integer User account
1 - Super admin 2 - Platform admin 3 - Member
Note: This field may return null, indicating that no valid values can be obtained.
UserName String User name
Note: This field may return null, indicating that no valid values can be obtained.

DescribeUserListData

User list data

Used by actions: DescribeUserList.

Name Type Description
UserId String User ID
Note: This field may return null, indicating that no valid values can be obtained.
UserAccount String User account
Note: This field may return null, indicating that no valid values can be obtained.
AccountType Integer Account type. 1: Super admin; 2: Platform admin; 3: Member
Note: This field may return null, indicating that no valid values can be obtained.
UserName String User name
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Status. 1: Normal; 2: Disabled
Note: This field may return null, indicating that no valid values can be obtained.
TeamName String Team name
Note: This field may return null, indicating that no valid values can be obtained.

DescribeUserListResp

User management list

Used by actions: DescribeUserList.

Name Type Description
TotalCount Integer Total number of entries
Note: This field may return null, indicating that no valid values can be obtained.
DataList Array of DescribeUserListData List data
Note: This field may return null, indicating that no valid values can be obtained.

DownloadApplicationConfigResp

Application configuration info

Used by actions: DescribeApplicationConfigFile.

Name Type Description
File String Configuration information in Base64 format
Note: This field may return null, indicating that no valid values can be obtained.

GlobalDomainDeleteResp

Response of deleting a global domain name

Used by actions: DeleteGlobalDomain.

Name Type Description
Result Boolean Response result
Note: This field may return null, indicating that no valid values can be obtained.

GlobalDomainModifyRespResp

Response of global domain name modification

Used by actions: ModifyGlobalDomain.

Name Type Description
Result Integer 0: Success; 1: Allowed domains; 2: Blocked domains
Note: This field may return null, indicating that no valid values can be obtained.

MNPTypeDefine

Mini program category information

Used by actions: DescribeMNPCategory.

Name Type Required Description
TypeName String No Mini program category name
Note: This field may return null, indicating that no valid values can be obtained.
TypeValue Array of String No Mini program category value
Note: This field may return null, indicating that no valid values can be obtained.
TypeId Integer No Category ID
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime Integer No Creation time
Note: This field may return null, indicating that no valid values can be obtained.
CreateUser String No Creator
Note: This field may return null, indicating that no valid values can be obtained.
IsSystem Boolean No Whether it is a system category
Note: This field may return null, indicating that no valid values can be obtained.

PresetResp

Encryption key returned

Used by actions: CreatePresetKey.

Name Type Description
Key String RSA encryption public key
Note: This field may return null, indicating that no valid values can be obtained.

QueryOnlineVersionResp

Mini program online version ID

Used by actions: DescribeMNPReleasedVersionHistory.

Name Type Description
MNPId String Mini program ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersion String Version
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionId Integer Version ID
Note: This field may return null, indicating that no valid values can be obtained.
MNPVersionNote String Version note
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.

ResourceIdInfo

Unified operation success ID - integer

Used by actions: ModifyMNP.

Name Type Description
ResourceId Integer Resource ID
0: No preview
1. A preview is currently available and uploaded by the current user.
2. A preview is currently available and uploaded by another user.
Note: This field may return null, indicating that no valid values can be obtained.

ResourceIdStringInfo

The general parameter for resource ID returned for successful operations

Used by actions: CreateApplication, CreateMNP, CreateMNPSensitiveAPIPermissionApproval, CreateUser.

Name Type Description
ResourceId String The ID of the resource returned
Note: This field may return null, indicating that no valid values can be obtained.

StringData

String object

Used by actions: DescribeMNPOfflinePackageURL.

Name Type Required Description
Data String No String type response data
Note: This field may return null, indicating that no valid values can be obtained.

UploadFileTempSecret

Temporary key for file upload

Used by actions: DescribeTempSecret4UploadFile2Cos.

Name Type Description
Bucket String Bucket
Note: This field may return null, indicating that no valid values can be obtained.
Region String Region
Note: This field may return null, indicating that no valid values can be obtained.
Path String Destination of upload
Note: This field may return null, indicating that no valid values can be obtained.
TempSecretId String Temporary secret ID
Note: This field may return null, indicating that no valid values can be obtained.
TempSecretKey String Temporary secret key
Note: This field may return null, indicating that no valid values can be obtained.
Token String Token
Note: This field may return null, indicating that no valid values can be obtained.
AccelerateEnable Integer Whether to enable global acceleration. Valid values: 0 (no), 1 (yes)
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon