文档中心>API 中心

数据结构

最近更新时间:2026-03-04 15:12:58

我的收藏

ChargePrepaidConfig

预付费类型相关配置

被如下接口引用:CreateEtcdInstance, ModifyEtcdConfiguration。

名称 类型 必选 描述
Period Integer 预付费购买周期,单位:月
示例值:1
RenewFlag String 预付费自动续费设置:
NOTIFY_AND_MANUAL_RENEW:表示默认状态(用户未设置,即初始状态), NOTIFY_AND_AUTO_RENEW:表示自动续费,DISABLE_NOTIFY_AND_MANUAL_RENEW:表示明确不自动续费(用户设置)
示例值:NOTIFY_AND_AUTO_RENEW

Etcd

etcd信息

被如下接口引用:DescribeEtcdInstances。

名称 类型 描述
InstanceId String 实例id
示例值:etcd-ctq51lvf
Name String 实例名
示例值:test
Description String 实例描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
VpcId String 实例所属vpcId
示例值:vpc-35lahm68
Version String etcd版本
示例值:v3.5.0
Status String 实例状态
示例值:running
Members Array of EtcdMember etcd成员信息
注意:此字段可能返回 null,表示取不到有效值。
Endpoint String 对外访问地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://10.0.1.127:1234
DeletionProtection Boolean 删除保护,true 删除保护开启;false删除保护关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

EtcdAdvancedSettings

etcd高级设置

被如下接口引用:CreateEtcdInstance。

名称 类型 必选 描述
SecuritySettings EtcdSecuritySettings 安全相关设置
示例值:x
AutoCompactionSettings EtcdAutoCompactionSettings 自动压缩设置
示例值:x
MonitorSettings EtcdMonitorSettings 监控设置
示例值:x
BackupSettings EtcdBackupSettings 备份相关设置
示例值:x
CustomDomains String 自定义域名
示例值:*.abc.com
CustomIPs String 自定义ip
示例值:127.0.0.1

EtcdAutoCompactionSettings

etcd自动压缩设置

被如下接口引用:CreateEtcdInstance, ModifyEtcdConfiguration。

名称 类型 必选 描述
AutoCompactionMode String 自动压缩模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:periodic
AutoCompactionRetention String 自动压缩保留时间/revison数
注意:此字段可能返回 null,表示取不到有效值。
示例值:5m

EtcdBackupSettings

etcd备份设置

被如下接口引用:CreateEtcdInstance, CreateEtcdSnapshotPolicy, DescribeEtcdSnapshotPolicies, ModifyEtcdSnapshotPolicy。

名称 类型 必选 描述
BackupInterval Integer 备份间隔(s)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
MaxBackupCount Integer 最大备份个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
User String 用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:user
Password String 密码
注意:此字段可能返回 null,表示取不到有效值。
示例值:password
CosBucketName String COS桶名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:tencentcloud-tke-etcd-backups-ap-guangzhou-1234567

EtcdCredential

etcd访问凭证

被如下接口引用:DescribeEtcdCredentials。

名称 类型 描述
CACert String CA证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:"-----BEGIN CERTIFICATE-----\n"
Cert String 证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:"-----BEGIN CERTIFICATE-----\n"
Key String 私钥
注意:此字段可能返回 null,表示取不到有效值。
示例值:"-----BEGIN RSA PRIVATE KEY-----"

EtcdMember

etcd集群成员信息

被如下接口引用:DescribeEtcdInstances。

名称 类型 描述
Name String 节点名字
示例值:etcd-6app8i2u-etcd-0
Version String 节点当前版本
示例值:v3.4.13.tke.2
Zone String 所属可用区
示例值:ap-chongqing-1
Status String 节点状态
示例值:Running

EtcdMonitorSettings

etcd监控设置

被如下接口引用:CreateEtcdInstance, ModifyEtcdConfiguration。

名称 类型 必选 描述
PrometheusCreationParam PrometheusCreationParam Prometheus创建参数
ExistedPrometheusInstanceId String Prometheus Id
示例值:prom-kkfzhlcn

EtcdSecuritySettings

etcd安全相关设置

被如下接口引用:CreateEtcdInstance。

名称 类型 必选 描述
Https Boolean 是否启用https
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ClientCertAuth Boolean 启用客户端证书认证
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

EtcdSnapshot

etcd快照

被如下接口引用:DescribeEtcdSnapshots。

名称 类型 描述
Name String 快照名称
示例值:test-snapshot
Size Integer 快照大小
示例值:1024

EtcdSnapshotPolicy

etcd快照策略

被如下接口引用:DescribeEtcdSnapshotPolicies。

名称 类型 描述
Name String 快照策略名称
示例值:default-backup-policy
BackupSettings EtcdBackupSettings 备份参数

EtcdTaskInfo

etcd task信息

被如下接口引用:DescribeEtcdTasks。

名称 类型 描述
TaskID String 任务ID
示例值:xxx-xxx
TaskType String 任务类型
示例值:enable_internet
ResourceID String 资源ID
示例值:etcd-xxx
LifeState String 任务状态
示例值:process
CreatedAt String 任务创建时间
示例值:2021-08-23 10:00:00
UpdatedAt String 任务更新时间
示例值:2021-08-23 10:00:00

Filter

过滤器

被如下接口引用:DescribeEtcdInstances, DescribeEtcdTasks。

名称 类型 必选 描述
Name String 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
示例值:instance-id
Values Array of String 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
示例值:["abc"]

InstanceConfig

实例配置信息

被如下接口引用:ModifyEtcdConfiguration。

名称 类型 必选 描述
Cpu Integer 核数
示例值:1
Mem Integer 内存大小Gi
示例值:2
Size Integer 集群规模
示例值:1

PrometheusCreationParam

Prometheus创建参数

被如下接口引用:ModifyEtcdConfiguration。

名称 类型 必选 描述
SubnetId String 子网ID
示例值:subnet-xxxx
DataRetention Integer 保存时长,只支持天单位
12d = 12天
示例值:10
GrafanaUserName String grafana用户名
示例值:admin
GrafanaPassword String grafana密码
示例值:admin

RPCMethod

RPC方法信息

被如下接口引用:DescribeRPCMethodList。

名称 类型 描述
Name String 方法名称
示例值:Alarm

RegionInstance

地域属性信息

被如下接口引用:DescribeEtcdRegions。

名称 类型 描述
RegionName String 地域名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
RegionId Integer 地域ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status String 地域状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
FeatureGates String 地域特性开关(按照JSON的形式返回所有属性)
注意:此字段可能返回 null,表示取不到有效值。
示例值:ALL
Alias String 地域简称
注意:此字段可能返回 null,表示取不到有效值。
示例值:gz
Remark String 地域白名单
注意:此字段可能返回 null,表示取不到有效值。
示例值:广州地域

TaskStepInfo

任务步骤信息

被如下接口引用:DescribeEtcdCreatingProgress。

名称 类型 描述
Step String 步骤名称
示例值:prepare_env
LifeState String 生命周期
pending : 步骤未开始
running: 步骤执行中
success: 步骤成功完成
failed: 步骤失败
示例值:running
StartAt String 步骤开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-03-29T11:30:17Z
EndAt String 步骤结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-03-29T11:30:17Z
FailedMsg String 若步骤生命周期为failed,则此字段显示错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:error

VersionInstance

版本信息

被如下接口引用:DescribeEtcdAvailableVersions。

名称 类型 描述
Name String 版本名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:etcd
Version String 版本信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:v3.4.13.tke.2
Remark String Remark信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:""