tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-11-06 18:10:46

    Ability

    Features supported by the cluster

    Used by actions: DescribeClusterDetail, DescribeClusters.

    Name Type Required Description
    IsSupportSlaveZone String Yes Whether secondary AZ is supported
    NonsupportSlaveZoneReason String Yes The reason why secondary AZ is not supported
    Note: This field may return null, indicating that no valid values can be obtained.
    IsSupportRo String Yes Whether read-only instance is supported
    NonsupportRoReason String Yes The reason why read-only instance is not supported
    Note: This field may return null, indicating that no valid values can be obtained.

    Account

    Database account information

    Used by actions: DescribeAccounts.

    Name Type Description
    AccountName String Database account name
    Description String Database account description
    CreateTime Timestamp Creation time
    UpdateTime Timestamp Update time
    Host String Host
    MaxUserConnections Integer The max connections

    Addr

    Database address

    Used by actions: DescribeClusterDetail.

    Name Type Description
    IP String IP address
    Port Integer Port

    AuditRuleFilters

    Filter of rule audit

    Used by actions: DescribeAuditRuleWithInstanceIds, ModifyAuditService, OpenAuditService.

    Name Type Required Description
    RuleFilters Array of RuleFilters Yes Audit rule

    AuditRuleTemplateInfo

    Details of an audit rule template

    Used by actions: DescribeAuditRuleTemplates.

    Name Type Description
    RuleTemplateId String Rule template ID
    RuleTemplateName String Rule template name
    RuleFilters Array of RuleFilters Filter of the rule template
    Description String Description of a rule template
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateAt String Creation time of a rule template

    BackupFileInfo

    Backup file information

    Used by actions: DescribeBackupList.

    Name Type Description
    SnapshotId Integer Snapshot file ID, which is deprecated. You need to use BackupId.
    FileName String Backup file name
    FileSize Integer Backup file size
    StartTime String Backup start time
    FinishTime String Backup end time
    BackupType String Backup type. Valid values: snapshot (snapshot backup), logic (logic backup).
    BackupMethod String Back mode. auto: auto backup; manual: manual backup
    BackupStatus String Backup file status. success: backup succeeded; fail: backup failed; creating: creating backup file; deleting: deleting backup file
    SnapshotTime String Backup file time
    BackupId Integer Backup ID
    Note: This field may return null, indicating that no valid values can be obtained.
    SnapShotType String
    BackupName String Backup file alias
    Note: This field may return null, indicating that no valid values can be obtained.

    BillingResourceInfo

    Billable resource information

    Used by actions: DescribeResourcesByDealName.

    Name Type Description
    ClusterId String Cluster ID
    InstanceIds Array of String Instance ID list
    DealName String Order ID

    BindInstanceInfo

    Information of the instance bound to the resource pack

    Used by actions: DescribeResourcePackageList.

    Name Type Description
    InstanceId String ID of the bound cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceRegion String Region of the instance bound Note: This field may return null, indicating that no valid values can be obtained.
    InstanceType String Type of the instance bound Note: This field may return null, indicating that no valid values can be obtained.
    ExtendIds Array of String ID of the instance in the bound cluster
    Note: This field may return null, indicating that no valid values can be obtained.

    BinlogItem

    Binlog description

    Used by actions: DescribeBinlogs.

    Name Type Description
    FileName String Binlog filename
    FileSize Integer File size in bytes
    StartTime String Transaction start time
    FinishTime String Transaction end time
    BinlogId Integer Binlog file ID

    ClusterInstanceDetail

    Cluster instance information

    Used by actions: DescribeClusterDetail.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    InstanceType String Engine type
    InstanceStatus String Instance status
    InstanceStatusDesc String Instance status description
    InstanceCpu Integer Number of CPU cores
    InstanceMemory Integer Memory
    InstanceStorage Integer Disk
    InstanceRole String Instance role
    MaintainStartTime Integer Execution start time in seconds from 0:00
    Note: This field may return null, indicating that no valid values can be obtained.
    MaintainDuration Integer Duration in seconds
    Note: This field may return null, indicating that no valid values can be obtained.
    MaintainWeekDays Array of String Execution time. Valid values: Mon, Tue, Wed, Thu, Fri, Sat, Sun`.
    Note: This field may return null, indicating that no valid values can be obtained.
    ServerlessStatus String Serverless instance enablement status
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceTasks Array of ObjectTask
    InstanceDeviceType String

    CynosdbCluster

    Cluster information

    Used by actions: DescribeClusters.

    Name Type Required Description
    Status String Yes Cluster status. Valid values are as follows:
    creating
    running
    isolating
    isolated
    activating (removing isolation)
    offlining (deactivating)
    offlined (deactivated)
    deleting
    deleted
    UpdateTime String Yes Update time
    Zone String Yes AZ
    ClusterName String Yes Cluster name
    Region String Yes Region
    DbVersion String Yes Database version
    ClusterId String Yes Cluster ID
    InstanceNum Integer Yes Number of instances
    Uin String Yes User UIN
    Note: This field may return null, indicating that no valid values can be obtained.
    DbType String Yes Engine type
    Note: This field may return null, indicating that no valid values can be obtained.
    AppId Integer Yes User appid
    Note: This field may return null, indicating that no valid values can be obtained.
    StatusDesc String Yes Cluster status description
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Yes Cluster creation time
    Note: This field may return null, indicating that no valid values can be obtained.
    PayMode Integer Yes Billing mode. 0: Pay-as-you-go; 1: Monthly subscription.
    Note: This field may return null, indicating that no valid values can be obtained.
    PeriodEndTime String Yes End time
    Note: This field may return null, indicating that no valid values can be obtained.
    Vip String Yes Cluster read-write VIP
    Note: This field may return null, indicating that no valid values can be obtained.
    Vport Integer Yes Cluster read-write vport
    Note: This field may return null, indicating that no valid values can be obtained.
    ProjectID Integer Yes Project ID
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No VPC ID
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No Subnet ID
    Note: This field may return null, indicating that no valid values can be obtained.
    CynosVersion String No TDSQL-C kernel version
    Note: This field may return null, indicating that no valid values can be obtained.
    StorageLimit Integer No Storage capacity
    Note: This field may return null, indicating that no valid values can be obtained.
    RenewFlag Integer No Renewal flag
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcessingTask String No Task in progress
    Note: This field may return null, indicating that no valid values can be obtained.
    Tasks Array of ObjectTask No Array of tasks in the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourceTags Array of Tag No Array of tags bound to the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    DbMode String No Database type. Valid values: NORMAL, SERVERLESS.
    Note: This field may return null, indicating that no valid values can be obtained.
    ServerlessStatus String No Serverless cluster status when the database type is SERVERLESS. Valid values:
    resume
    pause
    Note: This field may return null, indicating that no valid values can be obtained.
    Storage Integer No Prepaid cluster storage capacity
    Note: This field may return null, indicating that no valid values can be obtained.
    StorageId String No Cluster storage ID used in prepaid storage modification
    Note: This field may return null, indicating that no valid values can be obtained.
    StoragePayMode Integer No Billing mode of cluster storage. Valid values: 0 (pay-as-you-go), 1 (monthly subscription).
    Note: This field may return null, indicating that no valid values can be obtained.
    MinStorageSize Integer No The minimum storage corresponding to the compute specification of the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    MaxStorageSize Integer No The maximum storage corresponding to the compute specification of the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    NetAddrs Array of NetAddr No Network information of the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    PhysicalZone String No Physical AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterZone String No Primary AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    HasSlaveZone String No Whether there is a secondary AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    SlaveZones Array of String No Secondary AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    BusinessType String No Business type
    Note: This field may return null, indicating that no valid values can be obtained.
    IsFreeze String No Whether to freeze
    Note: This field may return null, indicating that no valid values can be obtained.
    OrderSource String No Order source
    Note: This field may return null, indicating that no valid values can be obtained.
    Ability Ability No Capability
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourcePackages Array of ResourcePackage No Information of the resource pack bound to an instance when packageType is DISK. Note: This field may return null, indicating that no valid values can be obtained.

    CynosdbClusterDetail

    Cluster details

    Used by actions: DescribeClusterDetail.

    Name Type Description
    ClusterId String Cluster ID
    ClusterName String Cluster name
    Region String Region
    Zone String AZ
    PhysicalZone String Physical AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    Status String Status
    StatusDesc String Status description
    ServerlessStatus String Serverless cluster status when the database type is SERVERLESS. Valid values:
    resume
    resuming
    pause
    pausing
    StorageId String Storage ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Storage Integer Storage capacity in GB
    Note: This field may return null, indicating that no valid values can be obtained.
    MaxStorageSize Integer Maximum storage specification in GB
    Note: This field may return null, indicating that no valid values can be obtained.
    MinStorageSize Integer Minimum storage specification in GB
    Note: This field may return null, indicating that no valid values can be obtained.
    StoragePayMode Integer Storage billing mode. Valid values: 1 (monthly subscription), 0 (pay-as-you-go).
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcName String VPC name
    VpcId String Unique VPC ID
    SubnetName String Subnet name
    SubnetId String Subnet ID
    Charset String Character set
    CreateTime String Creation time
    DbType String Database type
    DbMode String Database type. Valid values: normal, serverless.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbVersion String Database version
    StorageLimit Integer Maximum storage space
    Note: This field may return null, indicating that no valid values can be obtained.
    UsedStorage Integer Used capacity
    Vip String VIP
    Vport Integer vport
    RoAddr Array of Addr VIP and vport of the read-only instance in a cluster
    Ability Ability Features supported by the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    CynosVersion String TDSQL-C version
    Note: This field may return null, indicating that no valid values can be obtained.
    BusinessType String Business type
    Note: This field may return null, indicating that no valid values can be obtained.
    HasSlaveZone String Whether there is a secondary AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    IsFreeze String Whether to freeze
    Note: This field may return null, indicating that no valid values can be obtained.
    Tasks Array of ObjectTask Task list
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterZone String Primary AZ
    Note: This field may return null, indicating that no valid values can be obtained.
    SlaveZones Array of String Secondary AZ list
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceSet Array of ClusterInstanceDetail Instance information
    PayMode Integer Billing mode
    PeriodEndTime String Expiration time
    ProjectID Integer Project ID
    ResourceTags Array of Tag Array of tags bound to instance
    ProxyStatus String Proxy status
    Note: This field may return null, indicating that no valid values can be obtained.
    LogBin String Binlog switch. Valid values: ON, OFF.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsSkipTrade String Whether to skip the transaction
    Note: This field may return null, indicating that no valid values can be obtained.
    PitrType String PITR type. Valid values: normal, redo_pitr.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsOpenPasswordComplexity String Whether to enable password complexity
    Note: This field may return null, indicating that no valid values can be obtained.
    NetworkStatus String Network type
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourcePackages Array of ResourcePackage Information of the resource pack bound to a cluster Note: This field may return null, indicating that no valid values can be obtained.
    RenewFlag Integer The auto-renewal flag. Valid values: 0: (manual renewal, default), 1 (auto-renewal). Note: This field may return null, indicating that no valid values can be obtained.
    NetworkType String
    SlaveZoneAttr Array of SlaveZoneAttrItem

    CynosdbErrorLogItem

    Types of the returned error logs for an instance

    Used by actions: DescribeInstanceErrorLogs.

    Name Type Description
    Timestamp Integer Log timestamp Note: This field may return null, indicating that no valid values can be obtained.
    Level String Log level Note: This field may return null, indicating that no valid values can be obtained.
    Content String Log content Note: This field may return null, indicating that no valid values can be obtained.

    CynosdbInstance

    Instance information

    Used by actions: DescribeClusterInstanceGrps, DescribeInstances.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    DbMode String Instance type, which is used to indicate whether it is a serverless instance.
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    DestroyDeadlineText String Termination deadline
    IsolateTime Timestamp Isolation time
    NetType Integer Network type
    WanDomain String Public domain name
    WanIP String Public IP
    WanPort Integer Public port
    WanStatus String Public network status
    DestroyTime String Instance termination time
    CynosVersion String TDSQL-C kernel version
    ProcessingTask String Task in progress
    RenewFlag Integer Renewal flag
    MinCpu Float Minimum number of CPU cores for serverless instance
    MaxCpu Float Maximum number of CPU cores for serverless instance
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause
    StorageId String Prepaid storage ID
    Note: this field may return null, indicating that no valid value can be obtained.
    StoragePayMode Integer Storage billing mode
    PhysicalZone String Physical zone
    BusinessType String Business type
    Note: This field may return null, indicating that no valid value can be obtained.
    Tasks Array of ObjectTask Task
    Note: This field may return null, indicating that no valid values can be obtained.
    IsFreeze String Whether to freeze
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourceTags Array of Tag The resource tag
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterZone String Source AZ
    Note: This field may return null, indicating that no valid value can be obtained.
    SlaveZones Array of String Replica AZ
    Note: This field may return null, indicating that no valid value can be obtained.
    InstanceNetInfo Array of InstanceNetInfo Instance network information
    Note: This field may return null, indicating that no valid value can be obtained.
    ResourcePackages Array of ResourcePackage Information of the resource pack bound to an instance when packageType is CCU. Note: This field may return null, indicating that no valid values can be obtained.

    CynosdbInstanceDetail

    Instance details

    Used by actions: DescribeInstanceDetail.

    Name Type Description
    Uin String User Uin
    AppId Integer User AppId
    ClusterId String Cluster ID
    ClusterName String Cluster name
    InstanceId String Instance ID
    InstanceName String Instance name
    ProjectId Integer Project ID
    Region String Region
    Zone String AZ
    Status String Instance status
    StatusDesc String Instance status description
    DbType String Database type
    DbVersion String Database version
    Cpu Integer Number of CPU cores
    Memory Integer Memory in GB
    Storage Integer Storage capacity in GB
    InstanceType String Instance type
    InstanceRole String Current instance role
    UpdateTime Timestamp Update time
    CreateTime Timestamp Creation time
    PayMode Integer Billing mode
    PeriodEndTime Timestamp Instance expiration time
    NetType Integer Network type
    VpcId String VPC ID
    SubnetId String Subnet ID
    Vip String Private IP of instance
    Vport Integer Private port of instance
    WanDomain String Public domain name of instance
    Charset String Character set
    CynosVersion String TDSQL-C kernel version
    RenewFlag Integer Renewal flag
    MinCpu Float The minimum number of CPU cores for a serverless instance
    MaxCpu Float The maximum number of CPU cores for a serverless instance
    ServerlessStatus String Serverless instance status. Valid values:
    resume
    pause

    CynosdbInstanceGrp

    Instance group information

    Used by actions: DescribeClusterInstanceGrps.

    Name Type Description
    AppId Integer User appId
    ClusterId String Cluster ID
    CreatedTime Timestamp Creation time
    DeletedTime Timestamp Deletion time
    InstanceGrpId String Instance group ID
    Status String Status
    Type String Instance group type. ha: HA group; ro: RO group
    UpdatedTime Timestamp Update time
    Vip String Private IP
    Vport Integer Private port
    WanDomain String Public domain name
    WanIP String Public IP
    WanPort Integer Public port
    WanStatus String Public network status
    InstanceSet Array of CynosdbInstance Information of instances contained in instance group
    UniqVpcId String VPC ID
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqSubnetId String Subnet ID
    Note: This field may return null, indicating that no valid values can be obtained.
    OldAddrInfo OldAddrInfo Information of the old IP
    Note: This field may return null, indicating that no valid values can be obtained.
    ProcessingTasks Array of String Task in progress
    Tasks Array of ObjectTask Task list
    NetServiceId Integer biz_net_service table ID

    DatabasePrivileges

    Database permission list

    Used by actions: ModifyAccountPrivileges.

    Name Type Required Description
    Db String Yes Database
    Privileges Array of String Yes Permission list

    DatabaseTables

    Database table information

    Used by actions: CreateBackup, SearchClusterTables.

    Name Type Required Description
    Database String No Database name
    Note: This field may return null, indicating that no valid values can be obtained.
    Tables Array of String No Table name list
    Note: This field may return null, indicating that no valid values can be obtained.

    DbInfo

    Database details

    Used by actions: DescribeClusterDetailDatabases.

    Name Type Description
    DbName String Database name
    CharacterSet String Character set
    Status String Database status
    CollateRule String Collation
    Description String Database remarks Note: This field may return null, indicating that no valid values can be obtained.
    UserHostPrivileges Array of UserHostPrivilege User permissions Note: This field may return null, indicating that no valid values can be obtained.
    DbId Integer Database ID Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Timestamp ISO8601 Creation time Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime Timestamp ISO8601 Update time Note: This field may return null, indicating that no valid values can be obtained.
    AppId Integer User appid Note: This field may return null, indicating that no valid values can be obtained.
    Uin String User Uin Note: This field may return null, indicating that no valid values can be obtained.
    ClusterId String Cluster ID Note: This field may return null, indicating that no valid values can be obtained.

    ErrorLogItemExport

    The export format for an error log

    Used by actions: ExportInstanceErrorLogs.

    Name Type Required Description
    Timestamp String No Time Note: This field may return null, indicating that no valid values can be obtained.
    Level String No Log level. Valid values: error, warning, note. Note: This field may return null, indicating that no valid values can be obtained.
    Content String No Log content Note: This field may return null, indicating that no valid values can be obtained.

    InputAccount

    Account. Valid values: accountName, host.

    Used by actions: DeleteAccounts, ModifyAccountHost, ModifyAccountPrivileges.

    Name Type Required Description
    AccountName String Yes Account
    Host String No Host. Default value: %

    InstanceAuditRule

    Audit rule details of the instance, which is an output parameter of the DescribeAuditRuleWithInstanceIds API.

    Used by actions: DescribeAuditRuleWithInstanceIds.

    Name Type Description
    InstanceId String Instance ID.
    AuditRule Boolean Whether the audit is rule audit. Valid values: true (rule audit), false (full audit).
    Note: This field may return null, indicating that no valid values can be obtained.
    AuditRuleFilters Array of AuditRuleFilters Audit rule details, which is valid only when AuditRule is true.
    Note: This field may return null, indicating that no valid values can be obtained.

    InstanceInitInfo

    Instance initialization configuration information

    Used by actions: CreateClusters.

    Name Type Required Description
    Cpu Integer Yes Instance CPU
    Memory Integer Yes Instance memory
    InstanceType String Yes Instance type. Valid values:rw, ro.
    InstanceCount Integer Yes Number of the instances. Value range: 1-15.
    MinRoCount Integer No Minimum number of serverless instances. Value range: 1-15.
    MaxRoCount Integer No Maximum number of serverless instances. Value range: 1-15.
    MinRoCpu Float No Minimum specifications for serverless instance
    MaxRoCpu Float No Maximum specifications for serverless instance

    InstanceNetInfo

    Instance network information

    Used by actions: DescribeInstances.

    Name Type Description
    InstanceGroupType String Network type
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceGroupId String Instance group ID
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String VPC ID
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String Subnet ID
    Note: This field may return null, indicating that no valid values can be obtained.
    NetType Integer Network type
    Note: This field may return null, indicating that no valid values can be obtained.
    Vip String VPC IP
    Note: This field may return null, indicating that no valid values can be obtained.
    Vport Integer VPC port
    Note: This field may return null, indicating that no valid values can be obtained.
    WanDomain String Public network domain name
    Note: This field may return null, indicating that no valid values can be obtained.
    WanIP String
    WanPort Integer Public network port
    Note: This field may return null, indicating that no valid values can be obtained.
    WanStatus String Public network status
    Note: This field may return null, indicating that no valid values can be obtained.

    InstanceParamItem

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    InstanceId String Instance ID
    ParamsItems Array of ParamItemDetail List of instance parameters

    InstanceSpec

    Details of purchasable instance specifications. Cpu and Memory determine the instance specification during instance creation. The value range of the storage capacity is [MinStorageSize,MaxStorageSize]

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Cpu Integer Number of instance CPU cores
    Memory Integer Instance memory in GB
    MaxStorageSize Integer Maximum instance storage capacity GB
    MinStorageSize Integer Minimum instance storage capacity GB
    HasStock Boolean Whether there is an inventory.
    MachineType String Machine type
    MaxIops Integer Maximum IOPS
    MaxIoBandWidth Integer Maximum bandwidth
    ZoneStockInfos Array of ZoneStockInfo Inventory information in a region
    Note: This field may return null, indicating that no valid values can be obtained.
    StockCount Integer Quantity in stock
    Note: This field may return null, indicating that no valid values can be obtained.

    ModifiableInfo

    Details of whether the parameter can be modified

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity, DescribeParamTemplateDetail.

    Name Type Description

    ModifyParamItem

    Information of the modified instance parameter

    Used by actions: AddInstances, ModifyInstanceParam, ModifyParamTemplate.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes Current parameter value
    OldValue String No Old parameter value, which is used only in output parameters.
    Note: This field may return null, indicating that no valid values can be obtained.

    Module

    Modules supported by the system

    Used by actions: DescribeZones.

    Name Type Description
    IsDisable String Whether it is supported. Valid values: yes, no.
    ModuleName String Module name

    NetAddr

    Network information

    Used by actions: DescribeClusters, DescribeProxies.

    Name Type Description
    Vip String Private network IP
    Note: this field may return null, indicating that no valid values can be obtained.
    Vport Integer Private network port number
    Note: this field may return null, indicating that no valid values can be obtained.
    WanDomain String Public network domain name
    Note: this field may return null, indicating that no valid values can be obtained.
    WanPort Integer Public network port number
    Note: this field may return null, indicating that no valid values can be obtained.
    NetType String Network type. Valid values: ro (read-only), rw or ha (read-write)
    Note: this field may return null, indicating that no valid values can be obtained.
    UniqSubnetId String Subnet ID
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqVpcId String VPC ID
    Note: This field may return null, indicating that no valid values can be obtained.
    Description String Description
    Note: This field may return null, indicating that no valid values can be obtained.
    WanIP String Public IP
    Note: This field may return null, indicating that no valid values can be obtained.
    WanStatus String Public network status
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceGroupId String Instance group ID Note: This field may return null, indicating that no valid values can be obtained.

    NewAccount

    The newly created x08 account

    Used by actions: CreateAccounts.

    Name Type Required Description
    AccountName String Yes Account name, which can contain 1-16 letters, digits, and underscores. It must begin with a letter and end with a letter or digit.
    AccountPassword String Yes Password, which can contain 8-64 characters.
    Host String Yes Host
    Description String No Description
    MaxUserConnections Integer No Maximum number of user connections, which cannot be above 10,240.

    ObjectTask

    Task information

    Used by actions: DescribeClusterDetail, DescribeClusterInstanceGrps, DescribeClusters, DescribeInstances, DescribeProxies.

    Name Type Required Description
    TaskId Integer No Auto-Incrementing task ID
    Note: this field may return null, indicating that no valid values can be obtained.
    TaskType String No Task type
    Note: this field may return null, indicating that no valid values can be obtained.
    TaskStatus String No Task status
    Note: this field may return null, indicating that no valid values can be obtained.
    ObjectId String No Task ID (cluster ID | instance group ID | instance ID)
    Note: this field may return null, indicating that no valid values can be obtained.
    ObjectType String No Task type
    Note: this field may return null, indicating that no valid values can be obtained.

    OldAddrInfo

    Database address

    Used by actions: DescribeClusterInstanceGrps.

    Name Type Description
    Vip String IP
    Note: This field may return null, indicating that no valid values can be obtained.
    Vport Integer Port
    Note: This field may return null, indicating that no valid values can be obtained.
    ReturnTime String Expected valid hours of old IPs
    Note: This field may return null, indicating that no valid values can be obtained.

    Package

    Resource pack

    Used by actions: DescribeResourcePackageList.

    Name Type Description
    AppId Integer AppID Note: This field may return null, indicating that no valid values can be obtained.
    PackageId String The unique ID of a resource pack Note: This field may return null, indicating that no valid values can be obtained.
    PackageName String Resource pack name Note: This field may return null, indicating that no valid values can be obtained.
    PackageType String Resource pack type. Valid values: CCU (compute resource pack), DISK (storage resource pack). Note: This field may return null, indicating that no valid values can be obtained.
    PackageRegion String Region of the resource pack. Valid values: China (Chinese mainland), overseas (outside Chinese mainland). Note: This field may return null, indicating that no valid values can be obtained.
    Status String Resource pack status. Valid values: creating, using, expired, normal_finish (used up), apply_refund (requesting a refund), refund (refunded).
    Note: This field may return null, indicating that no valid values can be obtained.
    PackageTotalSpec Float Total number of resource packs Note: This field may return null, indicating that no valid values can be obtained.
    PackageUsedSpec Float Consumed usage of resource packs Note: This field may return null, indicating that no valid values can be obtained.
    HasQuota Boolean Remaining usage of resource packs Note: This field may return null, indicating that no valid values can be obtained.
    BindInstanceInfos Array of BindInstanceInfo Information of the instance bound Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String Validity time: 2022-07-01 00:00:00 Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Validity time: 2022-08-01 00:00:00 Note: This field may return null, indicating that no valid values can be obtained.

    PackageDetail

    Resource pack details

    Used by actions: DescribeResourcePackageDetail.

    Name Type Description
    AppId Integer Account ID of AppId Note: This field may return null, indicating that no valid values can be obtained.
    PackageId String The unique ID of a resource pack Note: This field may return null, indicating that no valid values can be obtained.
    InstanceId String Instance ID Note: This field may return null, indicating that no valid values can be obtained.
    SuccessDeductSpec Float The successfully deducted capacity Note: This field may return null, indicating that no valid values can be obtained.
    PackageTotalUsedSpec Float Used capacity of a resource pack as of now Note: This field may return null, indicating that no valid values can be obtained.
    StartTime String Deduction start time Note: This field may return null, indicating that no valid values can be obtained.
    EndTime String Deduction end time Note: This field may return null, indicating that no valid values can be obtained.
    ExtendInfo String Extended information Note: This field may return null, indicating that no valid values can be obtained.

    ParamDetail

    Instance parameter details

    Used by actions: DescribeParamTemplateDetail.

    Name Type Description
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    SupportFunc Boolean Whether func is supported. Valid values: true (supported), false (not supported).
    Default String Default value
    Description String Parameter description
    CurrentValue String Current value of the parameter
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes).
    Max String Maximum value of the parameter
    Min String Minimum value of the parameter
    EnumValue Array of String Enumerated values of the parameter. It is null if the parameter is non-enumerated. Note: This field may return null, indicating that no valid values can be obtained.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    MatchType String The match type. Valid value: multiVal.
    MatchValue String Match values, which will be separated by comma when MatchType is multiVal.
    IsFunc Boolean Whether it is a func type. Valid values: true (yes), false (no). Note: This field may return null, indicating that no valid values can be obtained.
    Func String Formula content returned when ParamType is func. Note: This field may return null, indicating that no valid values can be obtained.
    ModifiableInfo ModifiableInfo Whether the parameter can be modified Note: This field may return null, indicating that no valid values can be obtained.

    ParamInfo

    Parameter information

    Used by actions: DescribeClusterParams, DescribeClusterPasswordComplexity.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String List of valid values when parameter type is enum, string or bool.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max String Maximum value when parameter type is float or integer.
    Min String Minimum value when parameter type is float or integer.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the modified parameters to take effect.
    ParamType String Parameter type: integer, float, string, enum, bool.
    MatchType String Match type. Regex can be used when parameter type is string. Valid value: multiVal.
    MatchValue String Match values, which will be separated by semicolon when match type is multiVal.
    Description String Parameter description
    IsGlobal Integer Whether it is global parameter
    Note: This field may return null, indicating that no valid values can be obtained.
    ModifiableInfo ModifiableInfo Whether the parameter can be modified
    Note: This field may return null, indicating that no valid values can be obtained.
    IsFunc Boolean Whether it is a function
    Note: This field may return null, indicating that no valid values can be obtained.
    Func String Function
    Note: This field may return null, indicating that no valid values can be obtained.

    ParamItem

    Parameter to be modified

    Used by actions: CreateClusters, CreateParamTemplate, ModifyClusterParam.

    Name Type Required Description
    ParamName String Yes Parameter name
    CurrentValue String Yes New value
    OldValue String Yes Original value

    ParamItemDetail

    Instance parameter information

    Used by actions: DescribeInstanceParams.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String Enumerated values of the parameter It is null if the parameter is non-enumerated.
    IsGlobal Integer Valid values: 1 (global parameter), 0 (non-global parameter).
    Max String Maximum value
    Min String Minimum value
    NeedReboot Integer Whether to restart the database for the modified parameters to take effect. Valid values: 0 (no), 1 (yes)
    ParamName String Parameter name
    ParamType String Parameter type. Valid values: integer, enum, float, string, func.
    Description String Parameter description
    IsFunc Boolean Whether ParamType is a func Note: This field may return null, indicating that no valid values can be obtained.
    Func String Parameter configuration formula Note: This field may return null, indicating that no valid values can be obtained.

    ParamTemplateListInfo

    Parameter template information

    Used by actions: DescribeParamTemplates.

    Name Type Description
    Id Integer Parameter template ID
    TemplateName String Parameter template name
    TemplateDescription String Parameter template description
    EngineVersion String Engine version
    DbMode String Database Type. Valid values: NORMAL, SERVERLESS.
    ParamInfoSet Array of TemplateParamInfo Parameter template details
    Note: This field may return null, indicating that no valid values can be obtained.

    PolicyRule

    Security group rule

    Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

    Name Type Description
    Action String Policy, which can be ACCEPT or DROP
    CidrIp String Source IP or source IP range, such as 192.168.0.0/16
    PortRange String Port
    IpProtocol String Network protocol, such as UDP and TCP
    ServiceModule String Protocol port ID or protocol port group ID.
    AddressModule String IP address ID or IP address group ID.
    Id String id
    Desc String Description

    ProxyConnectionPoolInfo

    Connection pool information for the database proxy

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConnectionPoolTimeOut Integer Yes Connection persistence timeout in seconds
    Note: This field may return null, indicating that no valid values can be obtained.
    OpenConnectionPool String No Whether the connection pool is enabled
    Note: This field may return null, indicating that no valid values can be obtained.
    ConnectionPoolType String No Connection pool type. Valid value: SessionConnectionPool (session-level).
    Note: This field may return null, indicating that no valid values can be obtained.

    ProxyGroup

    Proxy group

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroupId String Database proxy group ID
    ProxyNodeCount Integer Number of nodes in the proxy group
    Status String Database proxy group status
    Region String Region
    Zone String AZ
    CurrentProxyVersion String Current proxy version
    ClusterId String Cluster ID
    Note: This field may return null, indicating that no valid values can be obtained.
    AppId Integer User AppId
    Note: This field may return null, indicating that no valid values can be obtained.
    OpenRw String Enabling read/write separation for database proxy
    Note: This field may return null, indicating that no valid values can be obtained.

    ProxyGroupInfo

    Database proxy group details

    Used by actions: DescribeProxies.

    Name Type Description
    ProxyGroup ProxyGroup Database proxy group
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyGroupRwInfo ProxyGroupRwInfo Read/write separation information of the database proxy group
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyNodes Array of ProxyNodeInfo Node information of the database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    ConnectionPool ProxyConnectionPoolInfo Connection pool information for the database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    NetAddrInfos Array of NetAddr Network information for database proxy
    Note: This field may return null, indicating that no valid values can be obtained.
    Tasks Array of ObjectTask Task set of the database proxy
    Note: This field may return null, indicating that no valid values can be obtained.

    ProxyGroupRwInfo

    Read/write separation information of the database proxy group

    Used by actions: DescribeProxies.

    Name Type Required Description
    ConsistencyType String No Consistency type. Valid values: eventual (eventual consistency), session (session consistency), global (global consistency).
    ConsistencyTimeOut Integer No Consistency timeout period
    WeightMode String No Weight mode. Valid values: system (auto-assigned), custom.
    FailOver String No Whether to enable failover
    AutoAddRo String No Whether to automatically add read-only instance. Valid value: yes, no.
    InstanceWeights Array of ProxyInstanceWeight No Instance weight array
    OpenRw String No Whether to enable read-write node. Valid values: yes, no.
    Note: This field may return null, indicating that no valid values can be obtained.
    RwType String No Read/write attribute. Valid values: READWRITE, READONLY.
    TransSplit Boolean No Transaction split
    AccessMode String No Connection mode. Valid values: balance, nearby.

    ProxyInstanceWeight

    Weight ratio between read-write instances and read-only instances

    Used by actions: CreateProxyEndPoint, DescribeProxies, ModifyProxyRwSplit.

    Name Type Required Description
    InstanceId String Yes InstanID
    Weight Integer Yes Instance weight

    ProxyNodeInfo

    Node in the database proxy group

    Used by actions: DescribeProxies, DescribeProxyNodes.

    Name Type Description
    ProxyNodeId String Database proxy node ID
    ProxyNodeConnections Integer Current node connections, which is not returned by the DescribeProxyNodes API.
    Cpu Integer CPU of the database proxy node
    Mem Integer Memory of the database proxy node
    Status String Status of the database proxy node
    ProxyGroupId String Database proxy group ID
    ClusterId String Cluster ID
    AppId Integer User AppID
    Region String Region
    Zone String AZ

    ProxySpec

    Database proxy specifications

    Used by actions: DescribeProxySpecs.

    Name Type Description
    Cpu Integer Number of database proxy CPU cores
    Mem Integer Database proxy memory

    ProxyZone

    Number of proxy nodes and their AZs

    Used by actions: CreateProxy, UpgradeProxy.

    Name Type Required Description
    ProxyNodeZone String No AZ of the proxy node
    ProxyNodeCount Integer No The number of proxy nodes

    QueryFilter

    Query filter

    Used by actions: DescribeClusters, DescribeInstances, DescribeProxyNodes.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match
    Name String No Search field
    Operator String No Operator

    QueryParamFilter

    Filters for query

    Used by actions: DescribeProxies.

    Name Type Required Description
    Names Array of String Yes Search field. Valid values: "InstanceId", "ProjectId", "InstanceName", "Vip"
    Values Array of String Yes Search string
    ExactMatch Boolean No Whether to use exact match

    ResourcePackage

    Information of a resource pack

    Used by actions: DescribeClusterDetail, DescribeClusters, DescribeInstances.

    Name Type Required Description
    PackageId String No The unique ID of a resource pack Note: This field may return null, indicating that no valid values can be obtained.
    PackageType String No Resource pack type. Valid values: CCU (compute resource pack), DISK (storage resource pack). Note: This field may return null, indicating that no valid values can be obtained.

    RollbackTimeRange

    Rollback time range

    Used by actions: DescribeRollbackTimeRange.

    Name Type Description
    TimeRangeStart String Start time
    TimeRangeEnd String End time

    RuleFilters

    Filter of the audit rule

    Used by actions: CreateAuditRuleTemplate, DescribeAuditRuleTemplates, DescribeAuditRuleWithInstanceIds, ModifyAuditRuleTemplates, ModifyAuditService, OpenAuditService.

    Name Type Required Description
    Type String Yes Filter parameter name of the audit rule. Valid values: host (client IP), user (database account), dbName (database name), sqlType (SQL type), sql (SQL statement).
    Compare String Yes Filter match type of the audit rule. Valid values: INC (including), EXC (excluding), EQS (equal to), NEQ (not equal to).
    Value Array of String Yes Filter match value of the audit rule

    SalePackageSpec

    Resource pack details

    Used by actions: DescribeResourcePackageSaleSpec.

    Name Type Description
    PackageRegion String Region of the resource pack Note: This field may return null, indicating that no valid values can be obtained.
    PackageType String Resource pack type. Valid values: CCU (compute resource pack), DISK (storage resource pack). Note: This field may return null, indicating that no valid values can be obtained.
    PackageVersion String Resource pack edition. Valid values: base (basic edition), common (general edition), enterprise (enterprise edition). Note: This field may return null, indicating that no valid values can be obtained.
    MinPackageSpec Float Minimum number of resources for the current edition of the resource pack. Unit of the compute resources: pcs. Unit of the storage resources: GB. Note: This field may return null, indicating that no valid values can be obtained.
    MaxPackageSpec Float Maximum number of resources for the current edition of the resource pack. Unit of the compute resources: pcs. Unit of the storage resources: GB. Note: This field may return null, indicating that no valid values can be obtained.
    ExpireDay Integer Validity period of a resource pack in days Note: This field may return null, indicating that no valid values can be obtained.

    SaleRegion

    Information of a purchasable region

    Used by actions: DescribeZones.

    Name Type Description
    Region String Region name
    RegionId Integer Numeric ID of a region
    RegionZh String Region name
    ZoneSet Array of SaleZone List of purchasable AZs
    DbType String Engine type
    Modules Array of Module Supported modules in a region

    SaleZone

    Information of a purchasable AZ

    Used by actions: DescribeZones.

    Name Type Description
    Zone String AZ name
    ZoneId Integer Numeric ID of an AZ
    ZoneZh String AZ name
    IsSupportServerless Integer Whether serverless cluster is supported. Valid values:

    0: No

    1: Yes
    IsSupportNormal Integer Whether standard cluster is supported. Valid values:

    0: No

    1: Yes
    PhysicalZone String Physical zone
    HasPermission Boolean Whether the user has AZ permission
    Note: This field may return null, indicating that no valid values can be obtained.
    IsWholeRdmaZone String Whether it is a full-linkage RDMA AZ.

    SecurityGroup

    Security group details

    Used by actions: DescribeDBSecurityGroups, DescribeProjectSecurityGroups.

    Name Type Description
    ProjectId Integer Project ID
    CreateTime String Creation time in the format of yyyy-mm-dd hh:mm:ss
    Inbound Array of PolicyRule Inbound rule
    Outbound Array of PolicyRule Outbound rule
    SecurityGroupId String Security group ID
    SecurityGroupName String Security group name
    SecurityGroupRemark String Security group remarks

    SlaveZoneAttrItem

    Used by actions: DescribeClusterDetail.

    Name Type Description
    Zone String
    BinlogSyncWay String

    SlowQueriesItem

    Slow query information of the instance

    Used by actions: DescribeInstanceSlowQueries.

    Name Type Description
    Timestamp Integer Execution timestamp
    QueryTime Float Execution duration in seconds
    SqlText String SQL statement
    UserHost String Client host
    UserName String Username
    Database String Database name
    LockTime Float Lock duration in seconds
    RowsExamined Integer Number of scanned rows
    RowsSent Integer Number of returned rows
    SqlTemplate String SQL template
    SqlMd5 String MD5 value of the SQL statement

    TablePrivileges

    MySQL table permission

    Used by actions: ModifyAccountPrivileges.

    Name Type Required Description
    Db String Yes Database name
    TableName String Yes Table name
    Privileges Array of String Yes Permission list

    Tag

    Information of tags associated with cluster, including TagKey and TagValue

    Used by actions: CreateClusters, DescribeClusterDetail, DescribeClusters, DescribeInstances.

    Name Type Required Description
    TagKey String Yes Tag key
    TagValue String Yes Tag value

    TemplateParamInfo

    Parameter template details

    Used by actions: DescribeParamTemplates.

    Name Type Description
    CurrentValue String Current value
    Default String Default value
    EnumValue Array of String The collection of valid value types when parameter type is enum.
    Note: This field may return null, indicating that no valid values can be obtained.
    Max String Maximum value when parameter type is float or integer.
    Note: This field may return null, indicating that no valid values can be obtained.
    Min String Minimum value when parameter type is float or integer.
    Note: This field may return null, indicating that no valid values can be obtained.
    ParamName String Parameter name
    NeedReboot Integer Whether to restart the instance for the parameter to take effect
    Description String Parameter description
    ParamType String Parameter type. Valid value: integer, float, string, enum.

    TradePrice

    Billing details

    Used by actions: InquirePriceCreate, InquirePriceRenew.

    Name Type Description
    TotalPrice Integer The non-discounted total price of monthly subscribed resources (unit: 0.000001 cent)
    Note: This field may return null, indicating that no valid values can be obtained.
    Discount Float Total discount. 100 means no discount.
    TotalPriceDiscount Integer The discounted total price of monthly subscribed resources (unit: 0.000001 cent). If a discount is applied, TotalPriceDiscount will be the product of TotalPrice and Discount.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPrice Integer The non-discounted unit price of pay-as-you-go resources (unit: 0.000001 cent)
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscount Integer The discounted unit price of pay-as-you-go resources (unit: 0.000001 cent). If a discount is applied, UnitPriceDiscount will be the product of UnitPrice and Discount.
    Note: This field may return null, indicating that no valid values can be obtained.
    ChargeUnit String Price unit

    UserHostPrivilege

    User host permissions

    Used by actions: CreateClusterDatabase, DescribeClusterDetailDatabases, ModifyClusterDatabase.

    Name Type Required Description
    DbUserName String Yes Authorized user
    DbHost String Yes Client IP Note: This field may return null, indicating that no valid values can be obtained.
    DbPrivilege String Yes User permissions Note: This field may return null, indicating that no valid values can be obtained.

    ZoneStockInfo

    Inventory information in an AZ

    Used by actions: DescribeInstanceSpecs.

    Name Type Description
    Zone String AZ
    HasStock Boolean Whether there is an inventory.
    StockCount Integer Quantity in stock
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy