数据结构

ApiKeyToken

API Key 访问凭证信息。描述云开发环境下 API Key 的完整信息，包括标识符、名称、令牌值、创建时间和过期时间。支持两种类型：api_key（服务端管理员访问凭证，用于服务端接口调用的身份认证，可设置有效期，单个环境最多 5 个）和 publish_key（前端匿名访问凭证，固定有效期，每个环境仅保留一个）。注意：令牌值（ApiKey 字段）仅在创建时返回完整明文，列表查询时将进行脱敏处理。

被如下接口引用：DescribeApiKeyList。

名称	类型	必选	描述
KeyId	String	否	API Key 的唯一标识符，由系统基于 UUID 自动生成的 Base64 URL 编码字符串。后续对该 API Key 进行删除、修改名称或精确查询操作时，均需使用该值作为定位参数 示例值：akdj3jsk3112ks
Name	String	否	API Key 的名称，即创建时传入的 KeyName 参数值。对于 publish_key 类型，该值固定为 publish_key 示例值：example_key
ApiKey	String	否	API Key 的令牌值（JWT 格式），用于服务端接口调用时的身份认证。出于安全考虑，仅在创建时返回一次完整明文；后续通过列表查询接口获取时，api_key 类型将进行脱敏处理；publish_key 类型始终返回完整明文。请在创建后妥善保存 注意：此字段可能返回 null，表示取不到有效值。 示例值：agKSFS**jKdhas
ExpireAt	Timestamp ISO8601	否	API Key 的过期时间，格式遵循 ISO 8601 标准。对于 api_key 类型：若创建时未指定有效期（ExpireIn），则该字段不返回，表示永不过期；若指定了有效期，则返回具体的过期时间。对于 publish_key 类型：始终返回，固定为约 2099 年 注意：此字段可能返回 null，表示取不到有效值。 示例值：2026-03-16T15:48:48+08:00
CreateAt	Timestamp ISO8601	否	API Key 的创建时间，格式遵循 ISO 8601 标准。对于 api_key 类型：为该 Key 实际创建时的时间。对于 publish_key 类型：若环境下已存在 publish_key 记录，则返回首次创建的时间而非本次调用时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2026-03-16T15:48:48+08:00

AuthDomain

合法域名

被如下接口引用：DescribeAuthDomains。

名称	类型	描述
Id	String	域名ID 示例值：114514
Domain	String	域名 示例值：cloudbase.tencentcloud.com
Type	String	域名类型。包含以下取值： SYSTEM USER 示例值：USER
Status	String	状态。包含以下取值： ENABLE DISABLE 示例值：ENABLE
CreateTime	Timestamp	创建时间 示例值：2024-01-01 00:00:00
UpdateTime	Timestamp	更新时间 示例值：2024-01-01 00:00:00

BaasPackageInfo

云开发新套餐详情

被如下接口引用：DescribeBaasPackageList。

名称	类型	描述
PackageName	String	DAU产品套餐ID 示例值：personal_calculation
PackageTitle	String	DAU套餐中文名称 示例值：个人版-计算型
GroupName	String	套餐分组 示例值：calculation
GroupTitle	String	套餐分组中文名 示例值：计算型
BillTags	String	json格式化计费标签，例如： {"pid":2, "cids":{"create": 2, "renew": 2, "modify": 2}, "productCode":"p_tcb_mp", "subProductCode":"sp_tcb_mp_cloudbase_dau"} 示例值：{"pid":2, "cids":{"create": 2, "renew": 2, "modify": 2}, "productCode":"p_tcb_mp", "subProductCode":"sp_tcb_mp_cloudbase_dau"}
ResourceLimit	String	json格式化用户资源限制，例如： {"Qps":1000,"InvokeNum":{"TimeUnit":"m", "Unit":"万次", "MaxSize": 100},"Capacity":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}, "Cdn":{"Flux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}, "BackFlux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100}},"Scf":{"Concurrency":1000,"OutFlux":{"TimeUnit":"m", "Unit":"GB", "MaxSize": 100},"MemoryUse":{"TimeUnit":"m", "Unit":"WGBS", "MaxSize": 100000}}} 示例值：参考接口示例
AdvanceLimit	String	json格式化高级限制，例如： {"CMSEnable":false,"ProvisionedConcurrencyMem":512000, "PictureProcessing":false, "SecurityAudit":false, "RealTimePush":false, "TemplateMessageBatchPush":false, "Payment":false} 示例值：参考接口示例
PackageDescription	String	套餐描述 示例值：适合商家小程序
IsExternal	Boolean	是否对外展示 示例值：false

BanConfig

封禁配置

被如下接口引用：DescribeGatewayVersions。

名称	类型	必选	描述
IpWhiteList	Array of String	否	ip白名单，支持ipv4、ipv6，支持CIDR 示例值：["1.86.245.225","192.168.1.0/22"]
IpBlackList	Array of String	否	ip黑名单，支持ipv4、ipv6，支持CIDR 示例值：["2402:4e00:31:801::323","2001:db8::/127"]
CountryWhiteList	Array of String	否	地域白名单（国家英文名） 示例值：["China"]
CountryBlackList	Array of String	否	地域黑名单（国家英文名） 示例值：["China"]

ClsInfo

cls日志信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
ClsRegion	String	cls所属地域 示例值：ap-shanghai
ClsLogsetId	String	cls日志集ID 示例值：xxx-yyy-zzz-***
ClsTopicId	String	cls日志主题ID 示例值：xxx-yyy-zzz-***
CreateTime	Timestamp	创建时间 示例值：2021-01-01 00:00:00

ClusterDetail

TDSQL-C数据库详情

被如下接口引用：DescribeMySQLClusterDetail。

名称	类型	描述
IsOpenPubNetAccess	Boolean	是否开启公网访问 示例值：true
MaxCpu	Float	最大算力 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.5
MinCpu	Float	最小算力 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.25
Status	String	TDSQL-C集群状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：running
UsedStorage	Integer	存储用量（单位：MB） 注意：此字段可能返回 null，表示取不到有效值。 示例值：21000000
StorageLimit	Integer	最大存储量（单位：GB） 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000
DbType	String	数据库类型 示例值：MYSQL
DbVersion	String	数据库类型 示例值：5.7
WanStatus	String	公网访问状态；open开启，opening开启中，closed关闭，closing关闭中 示例值：init
ClusterStatus	String	数据库集群状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：running
ServerlessStatus	String	serverless状态 示例值：pause

CreateIndex

本类型用于UpdateTable接口中描述待创建索引信息

被如下接口引用：UpdateTable。

名称	类型	必选	描述
IndexName	String	否	索引名称
MgoKeySchema	MgoKeySchema	否	索引结构

CreateMySQLResult

开通Mysql 结果

被如下接口引用：CreateMySQL。

名称	类型	描述
TaskId	String	任务ID 示例值：38654

CreateUserResp

创建用户返回结果

被如下接口引用：CreateUser。

名称	类型	描述
Uid	String	用户ID 示例值：1001

CustomLogConfig

安全网关自定义日志配置

被如下接口引用：DescribeGatewayVersions。

名称	类型	必选	描述
NeedReqBodyLog	Boolean	否	是否需要请求体 示例值：true
NeedReqHeaderLog	Boolean	否	是否需要请求头 示例值：true
NeedRspBodyLog	Boolean	否	是否需要回包体 示例值：true
NeedRspHeaderLog	Boolean	否	是否需要回包头部信息 示例值：true
LogSetId	String	否	cls set信息 示例值：setId
LogTopicId	String	否	cls topicId 示例值：topicId

DatabasesInfo

数据库资源信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
InstanceId	String	数据库唯一标识 示例值：tnt-xxxxyyyy
Status	String	状态。包含以下取值： INITIALIZING：资源初始化中 RUNNING：运行中，可正常使用的状态 UNUSABLE：禁用，不可用 OVERDUE：资源过期 示例值：RUNNING
Region	String	所属地域。 当前支持ap-shanghai 示例值：ap-shanghai
UpdateTime	Timestamp ISO8601	更新时间 示例值：2022-01-01 12:34:56

DbInstance

数据库连接器实例信息

被如下接口引用：RunSql。

名称	类型	必选	描述
EnvId	String	否	云开发环境ID 示例值：mikejliu-test01-5g7t7mwx7b84b3eb
InstanceId	String	否	MySQL 连接器实例 ID；"default" 或为空表示使用 TCB 环境的默认连接器 示例值：default
Schema	String	否	数据库名；为空时使用连接器配置的默认数据库名 示例值：classicmodels

DeleteUsersResp

删除tcb用户返回值

被如下接口引用：DeleteUsers。

名称	类型	描述
SuccessCount	Integer	成功个数 示例值：1
FailedCount	Integer	失败个数 示例值：0

DescribeCreateMySQLResult

查询开通Mysql结果

被如下接口引用：DescribeCreateMySQLResult。

名称	类型	描述
Status	String	状态 notexist | init | doing | success | fail 示例值：fail
FailReason	String	失败原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：Init Failed
FreezeStatus	Boolean	是否已被冻结（只在 Status=success时有效） 示例值：false

DescribeUserListResp

查询用户返回结果

被如下接口引用：DescribeUserList。

名称	类型	描述
Total	Integer	用户总数 示例值：16
UserList	Array of User	用户列表

DestroyMySQLResult

销毁 Mysql 结果

被如下接口引用：DestroyMySQL。

名称	类型	描述
IsSuccess	Boolean	是否成功 示例值：true
TaskId	String	任务ID 示例值：16710
TaskName	String	任务名 示例值：DeleteDataHub

DropIndex

本类型用于UpdateTable接口中描述待删除索引信息

被如下接口引用：UpdateTable。

名称	类型	必选	描述
IndexName	String	否	索引名称

EmailProviderConfig

邮箱登录配置

被如下接口引用：GetProviders, ModifyProvider。

名称	类型	必选	描述
SmtpConfig	EmailSmtpConfig	否	smtp配置
On	String	否	可选：TRUE，FALSE，如果On为TRUE，则表示采用默认代发。 示例值：TRUE

EmailSmtpConfig

邮箱smtp配置

被如下接口引用：ModifyProvider。

名称	类型	必选	描述
SenderAddress	String	否	邮件发送者的邮箱地址，即收件人看到的发件人地址。需为有效的邮箱格式，且须与 SMTP 服务器的授权账号一致，否则可能被邮件服务商拒绝发送。例如：abc@example.com 示例值：abc@123.com
ServerHost	String	否	SMTP 邮件服务器的域名或 IP 地址，用于建立邮件发送连接。不同邮件服务商的 SMTP 地址不同，例如 QQ 邮箱为 smtp.qq.com，Gmail 为 smtp.gmail.com，请以实际服务商提供的地址为准。 示例值：qq.smtp.com
ServerPort	Integer	否	SMTP 邮件服务器的端口号，需与所选安全模式（SecurityMode）匹配。常用端口：465（SSL 加密）、587（STARTTLS 加密）、25（无加密，不推荐）。建议优先使用 465 或 587 以保障传输安全。 示例值：465
AccountUsername	String	否	SMTP 服务器的登录账号，通常为发件人的完整邮箱地址。部分邮件服务商支持使用独立的 SMTP 授权账号，请以实际服务商的要求为准。 示例值：abc@123.com
AccountPassword	String	否	SMTP 服务器的登录密码。注意：部分邮件服务商（如 QQ 邮箱、163 邮箱）不支持直接使用账号登录密码，需在邮箱设置中开启 SMTP 服务并生成专用的授权码，请以实际服务商的要求为准。 示例值：xuiopdhya
SecurityMode	String	否	SMTP 连接的加密模式，用于保障邮件传输安全。可选值：AUTO（自动选择，优先使用安全连接）、SSL（全程 SSL/TLS 加密，通常配合端口 465 使用）、STARTSSL（通过 STARTTLS 命令升级为加密连接，通常配合端口 587 使用）、NO_SSL（不使用加密，仅建议在内网或测试环境中使用）。推荐使用 AUTO 或 SSL 以确保传输安全。 示例值：AUTO

EnvBillingInfoItem

环境计费信息

被如下接口引用：DescribeBillingInfo。

名称	类型	描述
EnvId	String	环境ID 示例值：env-xxxxxx
PackageId	String	tcb产品套餐ID，参考DescribePackages接口的返回值。 示例值：baas_personal
IsAutoRenew	Boolean	自动续费标记 示例值：true
Status	String	状态。包含以下取值： 空字符串：初始化中 NORMAL：正常 ISOLATE：隔离 示例值：NORMAL
PayMode	String	支付方式。包含以下取值： PREPAYMENT：预付费 POSTPAID：后付费 示例值：PREPAYMENT
IsolatedTime	String	隔离时间，最近一次隔离的时间 示例值：2022-01-01 12:34:56
ExpireTime	String	过期时间，套餐即将到期的时间 示例值：2022-01-01 12:34:56
CreateTime	String	创建时间，第一次接入计费方案的时间。 示例值：2022-01-01 12:34:56
UpdateTime	String	更新时间，计费信息最近一次更新的时间。 示例值：2022-01-01 12:34:56
IsAlwaysFree	Boolean	true表示从未升级过付费版。 示例值：false
PaymentChannel	String	付费渠道。 miniapp：小程序 qcloud：腾讯云 示例值：miniapp
OrderInfo	OrderInfo	最新的订单信息
FreeQuota	String	免费配额信息。 示例值：basic
EnableOverrun	Boolean	是否开启 超过套餐额度部分转按量付费 示例值：false
ExtPackageType	String	环境套餐类型 示例值：baas
EnvCharged	String	是否付费期环境，可取值：yes/no。 示例值：yes
EnvActivated	String	是否已激活，可取值：yes/no。 示例值：yes

EnvInfo

环境信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
EnvId	String	账户下该环境唯一标识 示例值：tcb-xxx
Source	String	环境来源。包含以下取值： miniapp：微信小程序 qcloud ：腾讯云 示例值：qcloud
Alias	String	环境别名，要以a-z开头，不能包含 a-zA-z0-9- 以外的字符 示例值：tcb
CreateTime	Timestamp	创建时间 示例值：2021-04-26
UpdateTime	Timestamp	最后修改时间 示例值：2021-04-26
Status	String	环境状态。包含以下取值： NORMAL：正常可用 UNAVAILABLE：服务不可用，可能是尚未初始化或者初始化过程中 示例值：NORMAL
Databases	Array of DatabasesInfo	数据库列表
Storages	Array of StorageInfo	存储列表
Functions	Array of FunctionInfo	函数列表
PackageId	String	tcb产品套餐ID，参考DescribePackages接口的返回值。 示例值：basic1
PackageName	String	套餐中文名称，参考DescribePackages接口的返回值。 示例值：基础版1
LogServices	Array of LogServiceInfo	云日志服务列表
StaticStorages	Array of StaticStorageInfo	静态资源信息
IsAutoDegrade	Boolean	是否到期自动降为免费版 示例值：false
EnvChannel	String	环境渠道 示例值：qc_console
PayMode	String	支付方式。包含以下取值： prepayment：预付费 postpaid：后付费 示例值：postpaid
IsDefault	Boolean	是否为默认环境 示例值：false
Region	String	环境所属地域 示例值：ap-shanghai
Tags	Array of Tag	环境标签列表
CustomLogServices	Array of ClsInfo	自定义日志服务
EnvType	String	环境类型：baas, run, hoting, weda 示例值：baas
IsDauPackage	Boolean	是否是dau新套餐 示例值：false
PackageType	String	套餐类型:空\baas\tcbr 示例值：baas
ArchitectureType	String	架构类型 示例值：multi_tenant ｜ stand_alone_cluster
Recycle	String	回收标志，默认为空 示例值：recycle | ""

ExternalStorage

外部存储。
标识该存储介质，并非由云开发CloudBase创建，而是绑定的其他存储介质。
目前仅支持 腾讯云-对象存储。

被如下接口引用：CreateStaticStore。

名称	类型	必选	描述
BucketName	String	是	桶名。 当 Provider=cos 时，表示腾讯云对象存储桶。 示例值：tcb-ext-stor-1257619089
Region	String	是	Bucket所属地域。 当 Provider=cos 时，表示腾讯云对象存储桶的所属地域。 示例值：ap-shanghai
BasePath	String	是	基础路径。 绑定之后，用户访问云存储内的文件，后台会自动以BasePath作为前缀，拼接到所访问的文件中。 例如： BasePath=my-cloudbase-path ， 当用户访问云存储内的 /tencentcloud.png 时，实际访问的完整路径是：/my-cloudbase-path/tencentcloud.png 示例值：ext-storage-v1
Enabled	Boolean	否	是否启用外部存储 示例值：true

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

被如下接口引用：DescribeHTTPServiceRoute。

名称	类型	必选	描述
Name	String	否	需要过滤的字段。过滤条件数量限制为10。
Values	Array of String	否	字段的过滤值。

FunctionInfo

函数的信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
Namespace	String	命名空间 示例值：ns-xxyyzzaa
Region	String	所属地域。 当前支持ap-shanghai 示例值：ap-shanghai

GatewayVersionItem

网关版本详情

被如下接口引用：DescribeGatewayVersions。

名称	类型	必选	描述
VersionName	String	是	版本名 示例值：versionName-xxx
Weight	Integer	是	版本流量权重 示例值：50
Status	String	否	创建状态 示例值：success
CreatedTime	String	否	创建时间 示例值：2021-04-15 13:54:49
UpdatedTime	String	否	更新时间 示例值：2021-04-15 13:54:49
BuildId	Integer	否	构建ID 示例值：buildid-xxx
Remark	String	否	备注 示例值：备注信息
Priority	Integer	否	优先级 示例值：1
IsDefault	Boolean	否	是否默认版本 示例值：true
CustomConfig	WxGatewayCustomConfig	否	网关版本自定义配置

HTTPServiceDomain

查询HTTP访问服务输出的域名信息，每个域名内包含所有路由信息

被如下接口引用：DescribeHTTPServiceRoute。

名称	类型	描述
Domain	String	域名 示例值：xxx.***.cn
DomainType	String	域名类型。 HTTPSERVICE: HTTP访问服务，CBR: 云托管服务，ANYSERVICE: 任意服务，AI_AGENT: AI agent，VM: 主机，INTEGRATION_CALLBACK: 集成回调 示例值：HTTPSERVICE
AccessType	String	绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务， CDN: 接入云开发CDN，CUSTOM: 自定义接入类型（其他CDN或者WAF） 示例值：CDN
CertId	String	证书ID。当前账户下SSL平台的证书ID 示例值：VF**
Protocol	String	协议类型。默认HTTP_AND_HTTPS。HTTP_AND_HTTPS: 同时开启http和https，HTTP_TO_HTTPS: http重定向成https，HTTPS_TO_HTTP: https重定向成http。如果未配置证书无法访问https或者进行重定向 示例值：HTTP_AND_HTTPS
Cname	String	配置DNS解析的CNAME。根据AccessType返回不同的CNAME值。 示例值：xxx.**.tcbaccess-expr.tencentcloudbase.com
IsDefault	Boolean	是否是默认域名 示例值：true
Enable	Boolean	域名开启状态 示例值：true
Status	String	状态。PROCESSING、FAIL，SUCCESS。 示例值：PROCESSING
DNSStatus	String	DNS解析状态。OK： 解析正常，INVALID：解析不正确，域名未解析到当前Cname域名。 示例值：INVALID
Routes	Array of HTTPServiceRoute	HTTP访问服务路由信息
CreateTime	Timestamp ISO8601	域名创建时间 示例值：2026-03-13T10:03:25+08:00
UpdateTime	Timestamp ISO8601	域名更新时间 示例值：2026-03-13T10:03:25+08:00

HTTPServiceDomainParam

创建或修改HTTP访问服务输入的域名信息，修改HTTP访问服务域名时对应字段不传参数表示不需要修改。

被如下接口引用：CreateHTTPServiceRoute, ModifyHTTPServiceRoute。

名称	类型	必选	描述
Domain	String	是	域名。全局唯一。如果域名在其他环境下占用或者腾讯云CDN占用，可能会导致创建失败 示例值：xxx.woyaodaguaishou.cn
AccessType	String	否	绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务， CDN: 接入云开发CDN，CUSTOM: 自定义接入类型（其他CDN或者WAF） 示例值：DIRECT
CertId	String	否	证书ID。当前账户下SSL平台的证书ID 示例值：VFw9N3uC
Protocol	String	否	协议类型。默认HTTP_AND_HTTPS。HTTP_AND_HTTPS: 同时开启http和https，HTTP_TO_HTTPS: http重定向成https，HTTPS_TO_HTTP: https重定向成http。如果未配置证书无法访问https或者进行重定向 示例值：HTTP_AND_HTTPS
CustomCname	String	否	自定义CNAME。对应AccessType: Custom 示例值：cdn.xxx.***.cn
Enable	Boolean	否	域名开启状态，不传默认开启 示例值：true
Routes	Array of HTTPServiceRouteParam	否	创建/修改的HTTP访问服务路由列表。如果不传，仅创建或修改域名信息。列表最大支持传入20个

HTTPServicePathRewrite

HTTP访问服务路径重写配置

被如下接口引用：CreateHTTPServiceRoute, DescribeHTTPServiceRoute, ModifyHTTPServiceRoute。

名称	类型	必选	描述
Prefix	String	否	路径前缀重写。StaticStorePrefix、Prefix只能填一个 示例值：/

HTTPServiceQPSPerClient

http访问服务客户端限频

被如下接口引用：CreateHTTPServiceRoute, DescribeHTTPServiceRoute, ModifyHTTPServiceRoute。

名称	类型	必选	描述
LimitBy	String	否	客户端维度限频标识。限制当前资源被单个客户端调用的频率，客户端标识支持 用户ID（UserID） 或 客户端 IP（ClientIP）。UserID 包括 云开发用户 ID 或 微信 openid，如果请求无 UserID 信息，则不会限制。 示例值：UserID
LimitValue	Integer	否	限制QPS值，每秒请求次数 示例值：10

HTTPServiceRoute

查询HTTP访问服务输出路由信息

被如下接口引用：DescribeHTTPServiceRoute。

名称	类型	描述
Path	String	路径 示例值：/api/v1
PathRewrite	HTTPServicePathRewrite	路径重写
UpstreamResourceType	String	上游服务类型。SCF: 云函数，CBR: 云托管，STATIC_STORE: 静态托管，WEB_SCF: WEB云函数，LH: Lighthouse 示例值：CBR
UpstreamResourceName	String	上游服务名 示例值：my-service
EnableSafeDomain	Boolean	是否开启安全域名 示例值：true
EnableAuth	Boolean	是否开启身份认证 示例值：true
EnablePathTransmission	Boolean	是否开启路径透传 示例值：true
QPSPolicy	HTTPServiceRouteQPSPolicy	QPS限频策略
Enable	Boolean	是否开启路由 示例值：true
CreateTime	Timestamp ISO8601	路由创建时间 示例值：2026-03-13T10:03:26+08:00
UpdateTime	Timestamp ISO8601	路由更新时间 示例值：2026-03-13T10:03:26+08:00

HTTPServiceRouteParam

创建或修改HTTP访问服务输入的路由信息，修改HTTP访问服务路由信息时对应字段不传参数表示不用修改。

被如下接口引用：CreateHTTPServiceRoute, ModifyHTTPServiceRoute。

名称	类型	必选	描述
Path	String	是	路径 示例值：/api/v1
UpstreamResourceType	String	否	上游服务类型。创建时必填，修改时可选填。SCF: 云函数，CBR: 云托管，STATIC_STORE: 静态托管，WEB_SCF: WEB云函数，LH: Lighthouse 示例值：CBR
UpstreamResourceName	String	否	上游服务名。创建时必填，修改时可选填 示例值：my-service
PathRewrite	HTTPServicePathRewrite	否	路径重写
EnableSafeDomain	Boolean	否	是否开启安全域名。默认开启 示例值：true
EnableAuth	Boolean	否	是否开启身份认证。默认关闭 示例值：true
EnablePathTransmission	Boolean	否	是否开启路径透传。默认关闭 示例值：true
QPSPolicy	HTTPServiceRouteQPSPolicy	否	QPS限频策略
Enable	Boolean	否	是否开启路由 示例值：true

HTTPServiceRouteQPSPolicy

云开发路由限频策略

被如下接口引用：CreateHTTPServiceRoute, DescribeHTTPServiceRoute, ModifyHTTPServiceRoute。

名称	类型	必选	描述
QPSTotal	Integer	否	QPS值，每秒请求次数 示例值：100
QPSPerClient	HTTPServiceQPSPerClient	否	客户端限频配置

HpaPolicy

扩缩容策略

被如下接口引用：DescribeCloudBaseRunServerVersion。

名称	类型	必选	描述
PolicyType	String	否	策略类型 示例值：cpu
PolicyThreshold	Integer	否	策略阈值 示例值：10

IndexAccesses

索引命中信息

被如下接口引用：DescribeTable。

名称	类型	描述
Ops	Integer	索引命中次数 注意：此字段可能返回 null，表示取不到有效值。
Since	String	命中次数从何时开始计数 注意：此字段可能返回 null，表示取不到有效值。

IndexInfo

索引信息

被如下接口引用：DescribeTable。

名称	类型	描述
Name	String	索引名称 注意：此字段可能返回 null，表示取不到有效值。
Size	Integer	索引大小，单位: 字节 注意：此字段可能返回 null，表示取不到有效值。
Keys	Array of Indexkey	索引键值 注意：此字段可能返回 null，表示取不到有效值。
Accesses	IndexAccesses	索引使用信息 注意：此字段可能返回 null，表示取不到有效值。
Unique	Boolean	是否为唯一索引 注意：此字段可能返回 null，表示取不到有效值。

Indexkey

索引的key值

被如下接口引用：DescribeTable。

名称	类型	描述
Name	String	键名
Direction	String	方向：specify 1 for ascending or -1 for descending

KVPair

键值对

被如下接口引用：DescribeCloudBaseBuildService。

名称	类型	必选	描述
Key	String	是	键 示例值：my-key
Value	String	是	值 示例值：my-value

LocalizedMessage

可以为每种语言配置一个字符串。比如：name，中文展示为：名字，英文展示为 name，韩文展示为：이름

被如下接口引用：AddProvider, GetProviders, ModifyProvider。

名称	类型	必选	描述
Message	String	是	默认展示的文本 示例值：name
Localized	Array of MessageLocalized	否	针对每种语言展示的文字 示例值：[{Message:"名字", "Locale": "zh"}]

LogObject

CLS日志单条信息

被如下接口引用：SearchClsLog。

名称	类型	描述
TopicId	String	日志属于的 topic ID 示例值：aafef2ab-19bc-4868-bd10-bd4a6e4146d6
TopicName	String	日志主题的名字 示例值：topic_env-xxyyzzaa
Timestamp	String	日志时间 示例值：2026-02-04 18:05:38.771
Content	String	日志内容 示例值：log-content
FileName	String	采集路径 示例值：/data/log/my-log-file.log
Source	String	日志来源设备 示例值：my-platform

LogResObject

CLS日志结果

被如下接口引用：SearchClsLog。

名称	类型	描述
Context	String	获取更多检索结果的游标 示例值：ctxjd84kjgkd7834kgj3875483jkdjfkd
ListOver	Boolean	搜索结果是否已经全部返回 示例值：false
Results	Array of LogObject	日志内容信息
AnalysisRecords	Array of String	日志聚合结果 示例值：["string"]

LogServiceInfo

云日志服务相关信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
LogsetName	String	log名 示例值：logset-env-xxyyzzaa
LogsetId	String	log-id 示例值：338230b0-6f63-4c7f-97c7-9a299d0b11f1
TopicName	String	topic名 示例值：topic-env-xxyyzzaadfs
TopicId	String	topic-id 示例值：80706322-b4ef-4617-b087-de81b7a5b6ca
Region	String	cls日志所属地域 示例值：ap-shanghai
Period	Integer	topic保存时长 默认7天 示例值：7

MFALoginConfig

多因子认证登录配置，用于管理 MFA（Multi-Factor Authentication）相关设置。包括 MFA 总开关、短信验证、邮箱验证、强制绑定手机号、TOTP 动态验证码等认证方式的独立开关配置。当 MFA 总开关（On）开启时，用户在登录后需完成额外的身份验证步骤。各子开关可独立控制具体的验证方式。不传则不修改当前配置。

被如下接口引用：DescribeLoginConfig, ModifyLoginConfig。

名称	类型	必选	描述
On	String	否	MFA 多因子认证开关。取值范围： TRUE：开启 MFA 多因子认证 FALSE：关闭 MFA 多因子认证 不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"
Sms	String	否	短信验证开关，控制是否在 MFA 流程中启用短信验证码校验。取值范围： TRUE：开启短信验证 FALSE：关闭短信验证 不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"
Email	String	否	邮箱验证开关，控制是否在 MFA 流程中启用邮箱验证码校验。取值范围： TRUE：开启邮箱验证 FALSE：关闭邮箱验证 不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值："FALSE"
RequiredBindPhone	String	否	强制绑定手机号开关，控制用户在完成 MFA 认证前是否必须绑定手机号。取值范围： TRUE：要求绑定手机号 FALSE：不要求绑定手机号 不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"

MessageLocalized

多语言文字，在 Locale 中 展示的 Message

被如下接口引用：AddProvider, ModifyProvider。

名称	类型	必选	描述
Message	String	是	字符串 示例值：name
Locale	String	是	在该语言中 示例值：zh-tw

MgoCommandParam

待执行命令

被如下接口引用：RunCommands。

名称	类型	必选	描述
TableName	String	是	表名
CommandType	String	是	操作类型，可选类型为：UPDATE/QUERY/INSERT/DELETE/COMMAND，本操作必须按实际填写，监控会依赖该字段统计本次操作的类型，并实时减少用户配额，如果填写错误会误扣用户请求配额
Command	String	是	待执行命令

MgoIndexKeys

本类型用于UpdateTable接口中描述待创建索引信息

被如下接口引用：UpdateTable。

名称	类型	必选	描述
Name	String	否	无 示例值：""
Direction	String	否	无 示例值：""

MgoKeySchema

本类型用于接口中描述待创建索引结构

被如下接口引用：UpdateTable。

名称	类型	必选	描述
MgoIndexKeys	Array of MgoIndexKeys	否	索引字段
MgoIsUnique	Boolean	否	是否唯一索引
MgoIsSparse	Boolean	否	是否稀疏索引

ModifyUserResp

修改用户返回值

被如下接口引用：ModifyUser。

名称	类型	必选	描述
Success	Boolean	否	是否成功 示例值：true

MongoConnector

MongoDB连接器配置

被如下接口引用：CreateTable, DeleteTable, DescribeTable, DescribeTables, ListTables, RunCommands, UpdateTable。

名称	类型	必选	描述
InstanceId	String	否	连接器实例ID 示例值：mongo_conn
DatabaseName	String	否	MongoDB数据库名 示例值：demo_db

MySQLClusterDetail

MySql 集群详情

被如下接口引用：DescribeMySQLClusterDetail。

名称	类型	描述
DbClusterId	String	集群ID 示例值：cynosdbmyl*ian***
NetInfo	MySQLNetDetail	网络详情
DbInfo	ClusterDetail	数据库详情

MySQLNetDetail

TDSQL-C网络信息类型

被如下接口引用：DescribeMySQLClusterDetail。

名称	类型	描述
PrivateNetAddress	String	内网地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.2****3306
PubNetAddress	String	外网地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：sh-cynosdbq****l8****sql.***c***3
Net	String	网络信息（VPCID/SubnetID） 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-py**/subnet-***p
PubNetAccessEnabled	Boolean	是否开通公网 示例值：true
VpcId	String	vpc id 示例值：vpc-p***
VpcName	String	vpc name 示例值：tcb_eul-f*-7gxt7zq098a*
SubnetId	String	子网ID 示例值：subnet-****
SubnetName	String	子网名 示例值：cloudbase_run_tdsqlc_subnet

MySQLTaskStatus

MySql 任务状态

被如下接口引用：DescribeMySQLTaskStatus。

名称	类型	描述
Status	String	SUCCESS | FAILED | PENDING 示例值：SUCCESS
StatusDesc	String	状态描述 示例值：SUCCESS

OrderInfo

订单信息

被如下接口引用：DescribeBillingInfo。

名称	类型	描述
TranId	String	订单号 示例值：202401011000004515
PackageId	String	订单要切换的套餐ID 示例值：baas_personal
TranType	String	订单类型 1 购买 2 续费 3 变配 示例值：1
TranStatus	String	订单状态。 1未支付 2 支付中 3 发货中 4 发货成功 5 发货失败 6 已退款 7 已取消 100 已删除 示例值：1
UpdateTime	String	订单更新时间 示例值：2024-01-01 00:00:00
CreateTime	String	订单创建时间 示例值：2024-01-01 00:00:00
PayMode	String	付费模式. prepayment 预付费 postpaid 后付费 示例值：prepayment
ExtensionId	String	订单绑定的扩展ID 示例值：ext-xyzabdkjks
ResourceReady	String	资源初始化结果(仅当ExtensionId不为空时有效): successful(初始化成功), failed(初始化失败), doing(初始化进行中), init(准备初始化) 示例值：successful
Flag	String	安装标记。建议使用方统一转大小写之后再判断。 QuickStart：快速启动来源 Activity：活动来源 示例值：QuickStart
ReqBody	String	下单时的参数 示例值：ReqBody

Pager

分页信息

被如下接口引用：DescribeTables, ListTables。

名称	类型	描述
Offset	Integer	分页偏移量 注意：此字段可能返回 null，表示取不到有效值。
Limit	Integer	每页返回记录数 注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	文档集合总数 注意：此字段可能返回 null，表示取不到有效值。

PasswordUpdateLoginConfig

登录配置中密码更新配置策略，用于管理使用用户名密码登录方式时，密码的过期策略和更新策略。例如，首次登录需要更新密码、定期过期密码等策略。

被如下接口引用：DescribeLoginConfig, ModifyLoginConfig。

名称	类型	必选	描述
FirstLoginUpdate	Boolean	否	首次登录强制修改密码开关。开启后，用户首次登录时将强制要求修改密码。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
PeriodUpdate	Boolean	否	定期强制修改密码开关。开启后，用户需按照 PeriodValue 和 PeriodType 指定的周期定期修改密码，超过周期未修改将在登录时强制要求修改。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
PeriodValue	Integer	否	定期修改密码的周期数值，与 PeriodType 配合使用。例如 PeriodValue 为 6，PeriodType 为 MONTH，表示每 6 个月需修改一次密码。当 PeriodUpdate 为 true 时必填。 注意：此字段可能返回 null，表示取不到有效值。 示例值：6
PeriodType	String	否	定期修改密码的周期时间单位，与 PeriodValue 配合使用。取值范围： WEEK：周 MONTH：月 YEAR：年 当 PeriodUpdate 为 true 时必填。 注意：此字段可能返回 null，表示取不到有效值。 示例值：MONTH

PermissionInfo

FlexDB数据库权限信息

被如下接口引用：CreateTable。

名称	类型	必选	描述
AclTag	String	是	"READONLY", //公有读，私有写。所有用户可读，仅创建者及管理员可写 "PRIVATE", //私有读写，仅创建者及管理员可读写 "ADMINWRITE", //所有用户可读，仅管理员可写 "ADMINONLY", //仅管理员可操作 "CUSTOM", // 安全规则 示例值：READONLY
EnvId	String	是	云开发环境ID 示例值：test-env-xxx
Rule	String	否	自定义规则

Provider

身份源配置信息。描述云开发环境下用户登录身份源的完整配置，定义了用户通过何种方式进入系统并完成身份认证。支持多种类型：包括标准协议身份源（OAuth 2.0、OIDC、SAML 2.0）、内置身份源（邮箱登录、自定义登录）以及通过插件机制扩展的身份源（如 CAS）。每个身份源包含认证配置、启用状态、用户自动注册策略、信息透传模式等核心属性，是登录认证流程的核心数据结构。

被如下接口引用：GetProviders。

名称	类型	必选	描述
Id	String	是	身份源的唯一标识符，用于在系统内区分不同的身份源。格式要求：2~32 位，仅支持小写英文字母和数字，不可包含空格或特殊字符。创建后不可修改 示例值：google
Config	ProviderConfig	是	身份源的安全认证配置，包含与第三方平台对接所需的核心参数，如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope 等。不同 ProviderType 对应不同的配置项。CUSTOM 类型无需手动配置（系统自动填充），OIDC 类型会根据 Issuer 自动补全端点信息，SAML 类型需提供 SamlMetadata（最大 10KB）
Name	LocalizedMessage	否	身份源的显示名称，支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段，建议根据实际业务场景填写易于识别的名称。未传入时默认使用 Id 值作为显示名称
Picture	String	否	身份源图标的访问地址，将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度，支持 HTTP/HTTPS 公网可访问的图片链接 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://example.com
Homepage	String	否	身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示，帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写：https://github.com 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://github.com
ProviderType	String	否	身份源协议类型，决定该身份源使用何种认证协议与第三方平台对接。可选值：OAUTH（标准 OAuth 2.0 协议）、OIDC（OpenID Connect 协议）、SAML（SAML 2.0 协议）、CUSTOM（自定义登录，使用 RSA 密钥对签名验证）、EMAIL（邮箱登录，需配合 EmailConfig 使用） 注意：此字段可能返回 null，表示取不到有效值。 示例值："OAUTH"
AutoSignUpWithProviderUser	String	否	控制第三方身份源登录时是否自动注册系统用户。可选值：TRUE（始终自动注册，无论第三方返回的用户信息是否包含手机号或邮箱）、FALSE（不自动注册，需用户手动绑定）、UNSPECIFIED（默认行为：仅当第三方身份源返回的用户信息中包含手机号或邮箱时才自动注册，否则登录完成后要求用户绑定手机号方可继续使用）。注意：企业微信类型（WX_WORK_AGENT/WX_WORK_INTERNAL/WX_WORK_THIRD_PARTY/WX_WORK_THIRD_PARTY_ASSOCIATION）和微信小程序类型（WX_MICRO_APP/WX_QRCODE_MICRO_APP/WX_OPEN）在 UNSPECIFIED 时会自动设为 TRUE。当 TransparentMode 为 TRUE 时，该字段将被强制设为 FALSE 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"
On	String	否	身份源的启用状态。可选值：TRUE（启用，用户可通过该身份源登录）、FALSE（禁用，已有绑定关系不受影响）。未传入时默认为 TRUE（启用） 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"
Description	LocalizedMessage	否	身份源的详细描述信息，支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景。 注意：此字段可能返回 null，表示取不到有效值。
TransparentMode	String	否	是否开启信息透传模式。可选值：TRUE（仅登录模式：平台不持久化存储用户数据，仅将第三方身份源返回的用户信息透传给业务方，适用于不希望平台留存用户数据的场景）、FALSE（登录且注册模式：平台正常注册并存储用户信息，默认值）。注意：开启透传模式时，AutoSignUpWithProviderUser 将被强制设为 FALSE；若 ReuseUserId 为 UNSPECIFIED，将被自动设为 TRUE。 注意：此字段可能返回 null，表示取不到有效值。 示例值："FALSE"
ReuseUserId	String	否	是否直接复用第三方身份源返回的用户标识（如 OpenID、UnionID 等）作为平台用户 ID。可选值：TRUE（开启，平台用户 ID 将直接使用第三方身份源返回的用户标识，适用于已有用户体系迁移场景）、FALSE（关闭，由平台生成独立用户 ID）。注意：开启后需确保第三方用户标识的全局唯一性，避免 ID 冲突。当 TransparentMode 为 TRUE 且该字段为 UNSPECIFIED 时，将被自动设为 TRUE 注意：此字段可能返回 null，表示取不到有效值。 示例值："FALSE"
EmailConfig	EmailProviderConfig	否	邮箱身份源的专项配置，仅当 ProviderType 为 EMAIL 时有效且必填。包含邮件服务商、发件人地址、SMTP 配置等参数，用于支持通过邮箱验证码方式进行身份认证。支持两种模式：自有 SMTP 服务器（需填写完整的 SMTP 配置）和平台代发（EmailConfig.On 设为 TRUE 时由平台随机分配 SMTP 服务器） 注意：此字段可能返回 null，表示取不到有效值。
AutoSignInWhenEmailMatch	String	否	是否开启邮箱自动关联登录。可选值：TRUE（开启）、FALSE（关闭）、UNSPECIFIED（默认为 FALSE）。开启后，若第三方身份源返回的邮箱与系统中已有用户的邮箱一致，则自动将该第三方账号与已有用户关联绑定并完成登录，无需用户手动绑定 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"
AutoSignInWhenPhoneNumberMatch	String	否	是否开启手机号自动关联登录。可选值：TRUE（开启）、FALSE（关闭）、UNSPECIFIED（默认行为等同于 TRUE，即默认开启）。开启后，若第三方身份源返回的手机号与系统中已有用户的手机号一致，则自动将该第三方账号与已有用户关联绑定并完成登录，无需用户手动绑定 注意：此字段可能返回 null，表示取不到有效值。 示例值："TRUE"

ProviderConfig

身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点（授权端点、令牌端点、用户信息端点、JWKS 端点等）、客户端凭证（ClientId、ClientSecret）、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。

被如下接口引用：AddProvider, GetProviders, ModifyProvider。

名称	类型	必选	描述
Issuer	String	否	身份提供方的唯一标识符（Issuer URL），用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写，值通常为第三方 OIDC 服务的根地址，例如：https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://appleid.apple.com
JwksUri	String	否	第三方身份提供方的 JSON Web Key Set 地址，用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer，该字段将通过 OpenID Connect Discovery 自动获取，无需手动填写。详情参考 OpenID Connect Discovery 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://appleid.apple.com/auth/keys
ClientId	String	否	在第三方身份提供方注册的应用客户端 ID，用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写，可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：client_id
ClientSecret	String	否	在第三方身份提供方注册的应用客户端密钥，与 ClientId 配合使用，用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写，请妥善保管，避免泄露。详情参考 OAuth 2.0 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：client_secret
RedirectUri	String	否	OAuth 授权完成后第三方平台回调的地址，需与在第三方平台注册的回调地址完全一致，否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写，并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://envId.ap-shanghai.tcb-api.tencentcloudapi.com/auth/v1/callback
Scope	String	否	向第三方身份提供方申请的权限范围，多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写，OIDC 场景下通常至少包含 openid，如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope，将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：openid email name
AuthorizationEndpoint	String	否	第三方身份提供方的授权端点地址，用于发起 OAuth/OIDC 授权请求，引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer，该字段将通过 OpenID Connect Discovery 自动获取，无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://appleid.apple.com/auth/authorize?response_mode=form_post
TokenEndpoint	String	否	第三方身份提供方的 Token 端点地址，用于通过授权码（code）换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer，该字段将通过 OpenID Connect Discovery 自动获取，无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://appleid.apple.com/auth/token
UserinfoEndpoint	String	否	第三方身份提供方的用户信息端点地址，用于通过 Access Token 获取用户的基本信息（如昵称、头像、邮箱等）。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer，该字段将通过 OpenID Connect Discovery 自动获取，无需手动填写。详情参考 OIDC 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：empty
ResponseType	String	否	OAuth/OIDC 授权请求的响应类型，决定授权端点返回的内容。可选值：code（授权码模式，推荐）、token（隐式模式，直接返回 Access Token）、id_token（直接返回 ID Token）。当 ProviderType 为 OIDC 时默认使用 id_token，其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：empty
SignoutEndpoint	String	否	第三方身份提供方的单点退出端点地址。配置后，用户退出当前应用时将被跳转至该地址，使第三方 IDP 的登录态也一并失效，实现单点退出（SLO）。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。 注意：此字段可能返回 null，表示取不到有效值。 示例值：empty
TokenEndpointAuthMethod	String	否	Token 端点的客户端身份验证方式，决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值：CLIENT_SECRET_POST（将凭证放在请求 Body 中传递）、CLIENT_SECRET_BASIC（将凭证通过 HTTP Basic Auth Header 传递）。当 ProviderType 为 OIDC 或 OAUTH 时可选填写，默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：CLIENT_SECRET_POST
SamlMetadata	String	否	SAML 身份提供方的 Metadata XML 内容，包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息，平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写，通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。 示例值：empty
RequestParametersMap	ProviderRequestParametersMap	否	请求参数映射配置，用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递，若对接的第三方平台（如微信、企业微信等）使用了非标准的参数名称或传参方式，可通过该字段配置自定义的参数映射规则，以确保请求参数与第三方平台的要求一致。 注意：此字段可能返回 null，表示取不到有效值。
ResponseParametersMap	ProviderResponseParametersMap	否	响应参数映射配置，用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数，若对接的第三方平台（如微信、企业微信等）返回了非标准的字段名称或数据结构，可通过该字段配置自定义的响应参数映射规则，将第三方返回的字段映射为平台标准字段。 注意：此字段可能返回 null，表示取不到有效值。

ProviderRequestParametersMap

三方认证入参映射。如果您的对接方不标准，则可以使用这个参数。默认情况下，该参数可以为空。比如：github,google,apple 接入，这些参数为空，但是国内的腾讯，新浪等则需要配置该参数。原因主要是：腾讯等公司在实现oauth时，未能完全遵循oauth标准。

被如下接口引用：AddProvider, ModifyProvider。

名称	类型	必选	描述
ClientId	String	否	OAuth 标准协议中的 client_id。不同第三方平台的字段名称可能不同，例如微信平台对应 appid、新浪微博对应 app_id。 示例值：clientId
ClientSecret	String	否	OAuth 标准协议中的 client_secret，用于身份认证源的密钥鉴权。请妥善保管，避免泄露。 示例值：clientSecret
RedirectUri	String	否	OAuth 标准协议中的 redirect_uri，即授权回调地址。用户完成第三方认证后将重定向至该地址。 示例值："https://xxxx"
RegisterUserRoleId	String	否	身份源注册用户时自动绑定的角色 ID。配置后，通过该身份源注册的新用户将自动关联指定角色。 示例值：1
RegisterUserAutoLicense	String	否	身份源注册用户时是否自动授予许可证。取值范围： TRUE：自动授权许可证 FALSE：不自动授权（默认值） 示例值："FALSE"
AuthPosition	String	否	OAuth 获取 Token 时认证信息的请求位置。取值范围： URL：将认证信息放在请求 URL 参数中 Headers：将认证信息放在请求 Header 中 Body：将认证信息放在请求 Body 中 示例值：Body
GrantType	String	否	OAuth 授权模式匹配的参数字段名。用于指定获取 Token 请求中 grant_type 参数对应的字段名称。 示例值：grantType
ClientCredentials	String	否	OAuth 授权模式类型。用于指定 grant_type 的值，例如 client_credentials 表示客户端凭证模式。 示例值：authorization_code
AccessToken	String	否	OAuth 返回中 access_token 的映射字段名。若第三方平台返回的 Token 字段名不是标准的 access_token，可通过此字段指定实际字段名。 示例值：accessToken
ExpiresIn	String	否	OAuth 返回中 Token 有效期的映射字段名。若第三方平台返回的有效期字段名不是标准的 expires_in，可通过此字段指定实际字段名。 示例值：expireIn
RegisterUserType	String	否	身份源注册用户时的用户类型。取值范围： externalUser：外部用户 internalUser：内部用户 默认值为 externalUser。 示例值：externalUser

ProviderResponseParametersMap

三方认证出参映射。如果您的对接方不标准，则可以使用这个参数。默认情况下，该参数可以为空。比如：microsoft, github,google,apple 接入，这些参数为空，但是国内的腾讯，新浪等则需要配置该参数。原因主要是：腾讯等公司在实现oauth时，未能完全遵循oauth标准。

被如下接口引用：AddProvider, ModifyProvider。

名称	类型	必选	描述
Sub	String	否	用户唯一标识（sub）的映射字段名。对应 OIDC 标准中的 sub 字段，值为第三方平台返回的用户信息 JSON 中表示用户 ID 的字段路径。例如github平台填sub。 注意：此字段可能返回 null，表示取不到有效值。 示例值：user_id
Name	String	否	用户名称（name）的映射字段名。对应 OIDC 标准中的 name 字段，值为第三方平台返回的用户信息 JSON 中表示用户昵称或姓名的字段路径。例如github平台填 name。 注意：此字段可能返回 null，表示取不到有效值。 示例值：name
Picture	String	否	用户头像（picture）的映射字段名。对应 OIDC 标准中的 picture 字段，值为第三方平台返回的用户信息 JSON 中表示用户头像 URL 的字段路径。需要公网可访问的url。 注意：此字段可能返回 null，表示取不到有效值。 示例值：avatar
Username	String	否	用户登录名（username）的映射字段名。对应 OIDC 标准中的 preferred_username 字段，值为第三方平台返回的用户信息 JSON 中表示用户唯一登录名的字段, 例如可使用sub或email等唯一值的字段。 注意：此字段可能返回 null，表示取不到有效值。 示例值：username
Email	String	否	用户邮箱（email）的映射字段名。对应 OIDC 标准中的 email 字段，值为第三方平台返回的用户信息 JSON 中表示用户邮箱地址的字段。 注意：此字段可能返回 null，表示取不到有效值。 示例值：email
PhoneNumber	String	否	用户手机号（phone_number）的映射字段名。对应 OIDC 标准中的 phone_number 字段，值为第三方平台返回的用户信息 JSON 中表示用户手机号的字段。 注意：此字段可能返回 null，表示取不到有效值。 示例值：phone_number
Groups	String	否	用户角色/分组（groups）的映射字段名。对应 OIDC 标准中的 groups 字段，值为第三方平台返回的用户信息 JSON 中表示用户所属角色或分组的字段路径。支持字符串数组类型的返回值。 注意：此字段可能返回 null，表示取不到有效值。 示例值：groups

StaticStorageInfo

静态CDN资源信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
StaticDomain	String	静态CDN域名 示例值：cloudbase.cloudbaseapp.com
DefaultDirName	String	静态CDN默认文件夹，当前为根目录 示例值："/"
Status	String	资源状态(process/online/offline/init) 示例值：online
Region	String	cos所属区域 示例值：ap-shanghai
Bucket	String	bucket信息 示例值：my-bucket-name-appid

StaticStoreInfo

静态托管资源信息

被如下接口引用：DescribeStaticStore。

名称	类型	描述
EnvId	String	环境ID 注意：此字段可能返回 null，表示取不到有效值。
CdnDomain	String	静态域名 注意：此字段可能返回 null，表示取不到有效值。
Bucket	String	COS桶 注意：此字段可能返回 null，表示取不到有效值。
Status	String	资源状态:init(初始化)/process(处理中)/online(上线)/destroying(销毁中)/offline(下线)) 注意：此字段可能返回 null，表示取不到有效值。
Region	String	地域 注意：此字段可能返回 null，表示取不到有效值。

StorageInfo

StorageInfo 资源信息

被如下接口引用：DescribeEnvs。

名称	类型	描述
Region	String	资源所属地域。 当前支持ap-shanghai 示例值：ap-shanghai
Bucket	String	桶名，存储资源的唯一标识 示例值：my-bucket-name-appid
CdnDomain	String	cdn 域名 示例值：cloudbase.tencentcloud.com
AppId	String	资源所属用户的腾讯云appId 示例值：1265124512

TableInfo

表信息

被如下接口引用：DescribeTables, ListTables。

名称	类型	描述
TableName	String	表名 注意：此字段可能返回 null，表示取不到有效值。
Count	Integer	表中文档数量 注意：此字段可能返回 null，表示取不到有效值。
Size	Integer	表的大小（即表中文档总大小），单位：字节 注意：此字段可能返回 null，表示取不到有效值。
IndexCount	Integer	索引数量 注意：此字段可能返回 null，表示取不到有效值。
IndexSize	Integer	索引占用空间，单位：字节 注意：此字段可能返回 null，表示取不到有效值。

Tag

标签键值对

被如下接口引用：CreateBillDeal, CreateEnv, DescribeEnvs。

名称	类型	必选	描述
Key	String	是	标签键 示例值：key
Value	String	是	标签值 示例值：value

TkeClusterInfo

tke集群信息

被如下接口引用：DescribeCloudBaseRunServerVersion。

名称	类型	必选	描述
ClusterId	String	否	集群ID 示例值：cls-xxxxxxx
VpcId	String	否	集群的vpcId 示例值：vpc-xxxxxx
VersionClbSubnetId	String	否	版本内网CLB所在子网Id 示例值：subnet-xxxxxxx

User

用户信息

被如下接口引用：DescribeUserList。

名称	类型	必选	描述
Uid	String	否	用户ID 示例值：1001
Name	String	否	用户名 示例值：zhangsan
Type	String	否	用户类型：internalUser-内部用户、externalUser-外部用户 示例值：internalUser
UserStatus	String	否	用户状态：ACTIVE（激活）、BLOCKED（冻结） 示例值：ACTIVE
NickName	String	否	用户昵称 示例值：张三
Phone	String	否	手机号 示例值：13800138000
Email	String	否	邮箱 示例值：zhangsan@example.com
AvatarUrl	String	否	头像链接 示例值：https://example.com/avatars/zhangsan.jpg
Description	String	否	用户描述 示例值：研发部门技术总监

VMLoginConfiguration

云服务器登录方式

被如下接口引用：CreateVmInstance。

名称	类型	必选	描述
LoginType	String	否	登录方式。扫码登录时指定为 SCAN_LOGIN 示例值：SCAN_LOGIN
AutoGeneratePassword	String	否	是否自动生成密码 示例值：YES
Password	String	否	指定密码登录 示例值：jyyyyy!@12
KeyIds	Array of String	否	绑定密钥ID 示例值：["lhkp-efloz5vs"]

VMPrice

虚拟主机价格

被如下接口引用：DescribeVmSpec。

名称	类型	描述
Currency	String	价格货币单位。取值范围CNY:人民币。USD:美元。 示例值：CNY
OriginalPrice	Float	原始价格 示例值：35
Discount	Float	折扣率 示例值：100
DiscountPrice	Float	折扣后的价格 示例值：35
OriginalCredits	Float	折扣前每天资源点 示例值：1152
DiscountCredits	Float	折扣后每天所需资源点 示例值：1152

VMSpec

VM规格

被如下接口引用：DescribeVmSpec。

名称	类型	描述
Type	String	LightHouse=轻量云服务器 CVM=云服务器 示例值：LightHouse
LightHouseSpec	VMSpecLightHouse	轻量云服务器规格。 当Type=LightHouse时有效
Price	VMPrice	价格信息

VMSpecLightHouse

vm规格

被如下接口引用：DescribeVmSpec。

名称	类型	描述
BundleId	String	LH主机的BundleId 示例值：bundle_starter_mc_med2_03
BundleConfig	String	主机配置详情json 示例值：{"BundleId": "bundle_starter_mc_med2_03","Memory":2,"BundleTypeDescription": "入门型"}

VerificationConfig

登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置，目前提供云开发默认短信包和客户自定义短信包，推荐使用云开发默认短信包。
如果使用自定义APIs发送短信，方法命名规则
方法名称：发送验证码
方法标识：SendVerificationCode
入参
Mobile：字符串（手机号，如：“+86 + 手机号”）
VerificationCode：字符串（验证码，如：“123456”）
返回值
ErrorCode：int（0 表示成功，非 0 表示失败）
ErrorMessage：字符串（ErrorCode 非 0 时，返回错误信息）

被如下接口引用：DescribeLoginConfig, ModifyLoginConfig。

名称	类型	必选	描述
Type	String	否	短信验证码发送通道类型。取值范围： default：使用默认云开发短信包发送短信。 apis：使用云开发自定义 APIs 作为短信发送通道，需配合 Name 和 Method 参数使用。 不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值：apis
Name	String	否	自定义 APIs 数据源唯一标识，当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。 注意：此字段可能返回 null，表示取不到有效值。 示例值：method_53978f9f96a35
Method	String	否	自定义 APIs 方法名，当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。 注意：此字段可能返回 null，表示取不到有效值。 示例值：SendVerificationCode
SmsDayLimit	Integer	否	单个手机号每日短信发送上限。默认值为 30，传 -1 表示不限制，如果设置为不限制，需要注意恶意攻击，导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。 注意：此字段可能返回 null，表示取不到有效值。 示例值：20

VmInstance

云主机实例

被如下接口引用：DescribeVmInstances。

名称	类型	必选	描述
InstanceId	String	否	实例id 示例值：lhins-20gnw292
Status	String	否	实例状态 示例值：Running
Region	String	否	实例地域 示例值：ap-shanghai

WxGatewayCustomConfig

安全网关自定义配置

被如下接口引用：DescribeGatewayVersions。

名称	类型	必选	描述
IsOpenXRealIp	Boolean	否	是否开启x-real-ip 示例值：false
BanConfig	BanConfig	否	封禁配置 示例值：false
SourceIpType	String	否	获取源ip方式，PPV1(Proxy Protocol V1)、PPV2(Proxy Protocol V2)、TOA(tcp option address) 示例值：PPV1
LogConfig	CustomLogConfig	否	日志信息
IsAcceptHttpOne	Boolean	否	是否开启http1.0 示例值：false