Data Types
Last updated: 2025-11-21 20:32:53
Acl
ACL object entity
Used by actions: DescribeACL.
| Name | Type | Description |
|---|---|---|
| ResourceType | Integer | ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only TOPIC is available, |
| ResourceName | String | Resource name, which is related to resourceType. For example, if resourceType is TOPIC, this field indicates the topic name; if resourceType is GROUP, this field indicates the group name |
| Principal | String | List of users, defaults to User:*, means any User is accessible in the entire region. the current User can only be the User in the list of users. |
| Host | String | Defaults to *, indicating any host is accessible in the entire region. currently, ckafka does not support * as the host, however, the following open-source kafka productization will directly support it. |
| Operation | Integer | ACL operation mode. 0: UNKNOWN, 1: ANY, 2: ALL, 3: READ, 4: WRITE, 5: CREATE, 6: DELETE, 7: ALTER, 8: DESCRIBE, 9: CLUSTER_ACTION, 10: DESCRIBE_CONFIGS, 11: ALTER_CONFIGS, 12: IDEMPOTEN_WRITE |
| PermissionType | Integer | Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW |
AclResponse
Set of returned ACL results
Used by actions: DescribeACL.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible data entries |
| AclList | Array of Acl | ACL list. |
AclRule
Output parameters of ACL rule list APIs
Used by actions: DescribeAclRule, DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| RuleName | String | ACL rule name. |
| InstanceId | String | The ckafka cluster instance Id. |
| PatternType | String | ACL rule-based matching type. currently only supports prefix match. valid values: PREFIXED. |
| Pattern | String | Indicates the prefix value for prefix match. |
| ResourceType | String | Acl resource type, currently only support Topic. valid values: Topic. |
| AclList | String | Specifies the ACL information contained in the rule. |
| CreateTimeStamp | String | Specifies the time when the rule was created. |
| IsApplied | Integer | Specifies whether to apply the preset ACL rule to newly-added topics. |
| UpdateTimeStamp | String | Rule update time. |
| Comment | String | Specifies the remark of the rule. |
| TopicName | String | One of the displayed corresponding TopicName. |
| TopicCount | Integer | Number of topics to which the ACL rule is applied. |
| PatternTypeTitle | String | Specifies the pattern type. |
AclRuleInfo
Four pieces of information of ACL rules: source IP address, destination IP address, source port, and destination port
Used by actions: BatchCreateAcl, CreateAclRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Operation | String | Yes | ACL operation types. Enumerated values: All (all operations), Read (read), Write (write). |
| PermissionType | String | Yes | Permission type. Deny: Deny. Allow: permission. |
| Host | String | Yes | Indicates any host is accessible in the entire region. |
| Principal | String | Yes | The User. User:* means any User is accessible in the entire region. the current User can only be the User in the list of users. the input format requires the [User:] prefix. for example, for User A, input User:A. |
AclRuleResp
Results returned by the AclRuleList API
Used by actions: DescribeAclRule.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of data entries |
| AclRuleList | Array of AclRule | AclRule list. |
Assignment
Stores the information of partition assigned to this consumer
Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.
| Name | Type | Description |
|---|---|---|
| Version | Integer | Assignment version information |
| Topics | Array of GroupInfoTopics | topic information list. |
BatchContent
Message content that can be sent in batches
Used by actions: SendMessage.
| Name | Type | Required | Description |
|---|---|---|---|
| Body | String | Yes | Message body that is sent. |
| Key | String | No | Message sending key name. |
BatchModifyTopicInfo
Topic parameters that can be modified in batches
Used by actions: BatchModifyTopicAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicName | String | Yes | Topic name |
| PartitionNum | Integer | No | The number of partitions. |
| Note | String | No | Remarks. |
| ReplicaNum | Integer | No | Number of replicas. |
| CleanUpPolicy | String | No | Message deletion policy. Valid values: delete, compact. |
| MinInsyncReplicas | Integer | No | The minimum number of replicas specified by min.insync.replicas when the producer sets request.required.acks to -1. |
| UncleanLeaderElectionEnable | Boolean | No | Whether to allow a non-ISR replica to be the leader. |
| RetentionMs | Integer | No | Message retention period in topic dimension in milliseconds. Value range: 1 minute to 90 days. |
| RetentionBytes | Integer | No | Specifies the message retention size in the topic dimension in bytes. value range: 1 GB to 1024 GB. |
| SegmentMs | Integer | No | Duration of Segment shard scrolling in milliseconds. value range: 1 day to 90 days. |
| MaxMessageBytes | Integer | No | Message size per batch. Value range: 1 KB - 12 MB. |
| LogMsgTimestampType | String | No | Specifies the time type for message storage: CreateTime/LogAppendTime. |
BatchModifyTopicResultDTO
Results of the batch modified topic attributes
Used by actions: BatchModifyTopicAttributes.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | The ckafka cluster instance Id. |
| TopicName | String | Topic name |
| ReturnCode | String | Operation return code. |
| Message | String | Returned information. |
ClusterInfo
Cluster information entity
Used by actions: DescribeCkafkaZone.
| Name | Type | Description |
|---|---|---|
| ClusterId | Integer | Cluster ID |
| ClusterName | String | Cluster name |
| MaxDiskSize | Integer | Maximum disk of the cluster (unit: GB). |
| MaxBandWidth | Integer | Maximum bandwidth of the cluster. unit: MB/s. |
| AvailableDiskSize | Integer | Current availability of cluster disk (unit: GB). |
| AvailableBandWidth | Integer | Available bandwidth of the cluster. unit: MB/s. |
| ZoneId | Integer | Indicates the AZ to which the cluster belongs. |
| ZoneIds | Array of Integer | The AZ where the cluster nodes are located. If the cluster is a cross-AZ cluster, it includes multiple AZs where the cluster nodes are located. |
Config
Advanced configuration object
Used by actions: DescribeTopicAttributes, DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| Retention | Integer | Message retention period in milliseconds. |
| MinInsyncReplicas | Integer | Minimum number of sync replications Note: this field may return null, indicating that no valid values can be obtained. |
| CleanUpPolicy | String | Log cleanup mode. Default value: delete. delete: logs will be deleted by save time; compact: logs will be compressed by key; compact, delete: logs will be compressed by key and deleted by save time. Note: this field may return null, indicating that no valid values can be obtained. |
| SegmentMs | Integer | Duration of Segment shard scrolling in milliseconds. Note: This field may return null, indicating that no valid values can be obtained. |
| UncleanLeaderElectionEnable | Integer | 0: false, 1: true. Note: this field may return null, indicating that no valid values can be obtained. |
| SegmentBytes | Integer | Segment specifies the number of bytes for sharding scroll. unit: bytes. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxMessageBytes | Integer | Maximum message byte size. unit: bytes. Note: This field may return null, indicating that no valid values can be obtained. |
| RetentionBytes | Integer | Specifies the message retention file size in Bytes. Note: This field may return null, indicating that no valid values can be obtained. |
| LogMsgTimestampType | String | The time type for message saving. CreateTime means the time when the producer created this message. LogAppendTime means the time when the broker received the message. Note: This field may return null, indicating that no valid values can be obtained. |
ConsumerGroup
User group entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| ConsumerGroupName | String | User group name |
| SubscribedInfo | Array of SubscribedInfo | Subscribed message entity |
ConsumerGroupResponse
Returned consumer group result entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible consumer groups |
| TopicList | Array of ConsumerGroupTopic | Topic list. |
| GroupList | Array of ConsumerGroup | Specifies the consumption group List. |
| TotalPartition | Integer | Total number of partitions. |
| PartitionListForMonitor | Array of Partition | Monitored partition list. |
| TotalTopic | Integer | Total number of topics. |
| TopicListForMonitor | Array of ConsumerGroupTopic | Monitored topic list. |
| GroupListForMonitor | Array of Group | Monitored group list. |
ConsumerGroupTopic
Consumer group topic object
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| TopicName | String | Topic name |
ConsumerRecord
Message record
Used by actions: FetchMessageByOffset, FetchMessageListByOffset, FetchMessageListByTimestamp.
| Name | Type | Description |
|---|---|---|
| Topic | String | Topic name |
| Partition | Integer | Partition ID |
| Offset | Integer | Offset |
| Key | String | Message key Note: this field may return null, indicating that no valid values can be obtained. |
| Value | String | Message value Note: this field may return null, indicating that no valid values can be obtained. |
| Timestamp | Integer | Message timestamp. |
| Headers | String | Message headers Note: This field may return null, indicating that no valid values can be obtained. |
CreateInstancePostData
Data structure returned by the pay-as-you-go instance creation API
Used by actions: CreatePostPaidInstance.
| Name | Type | Description |
|---|---|---|
| FlowId | Integer | CreateInstancePre returns fixed as 0. it cannot be used as a query condition for CheckTaskStatus. this is merely to ensure alignment with the backend data structure. |
| DealNames | Array of String | Order ID list |
| InstanceId | String | The ckafka cluster instance Id. by default, returns the Id of the first purchased instance when purchasing multiple instances. |
| DealNameInstanceIdMapping | Array of DealInstanceDTO | Order and purchase mapping list corresponding to the instance. |
CreateInstancePostResp
Data structure returned by pay-as-you-go instance APIs
Used by actions: CreatePostPaidInstance.
| Name | Type | Description |
|---|---|---|
| ReturnCode | String | Returned code. 0 indicates normal status while other codes indicate errors. |
| ReturnMessage | String | Message returned by the API. An error message will be returned if the API reports an error. |
| Data | CreateInstancePostData | Specifies the Data returned. |
CreateInstancePreData
Data returned by the CreateInstancePre API.
Used by actions: CreateInstancePre, DeleteInstancePre, ModifyInstancePre.
| Name | Type | Description |
|---|---|---|
| FlowId | Integer | CreateInstancePre returns fixed as 0. it cannot be used as a query condition for CheckTaskStatus. this is merely to ensure alignment with the backend data structure. |
| DealNames | Array of String | Order ID list |
| InstanceId | String | The ckafka cluster instance Id. by default, returns the Id of the first purchased instance when purchasing multiple instances. |
| DealNameInstanceIdMapping | Array of DealInstanceDTO | Order and purchase mapping list corresponding to the instance. |
CreateInstancePreResp
Data structure returned by monthly subscribed instance APIs
Used by actions: CreateInstancePre, DeleteInstancePre, ModifyInstancePre.
| Name | Type | Description |
|---|---|---|
| ReturnCode | String | Returned code. 0: Normal; other values: Error. |
| ReturnMessage | String | The message indicating whether the operation is successful. |
| Data | CreateInstancePreData | Specifies the Data returned by the operation. |
CreateTopicResp
Return for topic creation
Used by actions: CreateTopic.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
CvmAndIpInfo
CVM and IP information.
Used by actions: DescribeCvmInfo.
| Name | Type | Description |
|---|---|---|
| CkafkaInstanceId | String | The ckafka cluster instance Id. |
| InstanceId | String | CVM instance ID (ins-test) or POD IP (10.0.0.30). |
| Ip | String | IP address. |
DatahubTopicDTO
DataHub topic
Used by actions: DescribeDatahubTopics.
| Name | Type | Description |
|---|---|---|
| Name | String | Name |
| TopicName | String | Topic name |
| TopicId | String | Topic ID |
| PartitionNum | Integer | The number of partitions |
| RetentionMs | Integer | Expiration time in milliseconds. |
| Note | String | Remarks |
| Status | Integer | Status (1: In use; 2: Deleting) |
DatahubTopicResp
DataHub topic response
Used by actions: CreateDatahubTopic.
| Name | Type | Description |
|---|---|---|
| TopicName | String | Topic name |
| TopicId | String | Topic Id. |
DealInstanceDTO
Mapping between orders and CKafka instances for monthly subscribed and pay-as-you-go instance APIs.
Used by actions: CreateInstancePre, CreatePostPaidInstance, DeleteInstancePre, ModifyInstancePre.
| Name | Type | Description |
|---|---|---|
| DealName | String | Order transaction. |
| InstanceIdList | Array of String | Order transaction corresponds to the list of purchased CKafka instance ids. |
DescribeConnectInfoResultDTO
Topic connection information
Used by actions: DescribeTopicProduceConnection.
| Name | Type | Description |
|---|---|---|
| IpAddr | String | IP address Note: This field may return null, indicating that no valid values can be obtained. |
| Time | String | Connection time Note: This field may return null, indicating that no valid values can be obtained. |
| IsUnSupportVersion | Boolean | Specifies whether supported versions are required or not. |
DescribeDatahubTopicResp
DataHub topic details
Used by actions: DescribeDatahubTopic.
| Name | Type | Description |
|---|---|---|
| Name | String | Name |
| TopicName | String | Topic name |
| TopicId | String | Topic ID |
| PartitionNum | Integer | The number of partitions |
| RetentionMs | Integer | Expiration time in milliseconds. |
| Note | String | Remarks. |
| UserName | String | Username |
| Password | String | Password |
| Status | Integer | Status (1: In use; 2: Deleting) |
| Address | String | Specifies the service routing address. |
DescribeDatahubTopicsResp
DataHub topic list
Used by actions: DescribeDatahubTopics.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total count |
| TopicList | Array of DatahubTopicDTO | Topic list. |
DescribeGroup
DescribeGroup response entity
Used by actions: DescribeGroup.
| Name | Type | Description |
|---|---|---|
| Group | String | Consumer group name. |
| Protocol | String | Protocol used by the group. |
DynamicDiskConfig
Dynamic disk expansion configuration
Used by actions: DescribeInstanceAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| Enable | Integer | No | Whether to enable dynamic disk expansion configuration. 0: disable, 1: enable.Note: this field may return null, indicating that no valid values can be obtained. |
| StepForwardPercentage | Integer | No | Percentage of dynamic disk expansion each time. Note: this field may return null, indicating that no valid values can be obtained. |
| DiskQuotaPercentage | Integer | No | Disk quota threshold (in percentage) for triggering the automatic disk expansion event. Note: this field may return null, indicating that no valid values can be obtained. |
| MaxDiskSpace | Integer | No | Max disk space in GB. Note: this field may return null, indicating that no valid values can be obtained. |
DynamicRetentionTime
Dynamic message retention time configuration
Used by actions: DescribeInstanceAttributes, ModifyInstanceAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| Enable | Integer | No | Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled Note: null may be returned for this field, indicating that no valid values can be obtained. |
| DiskQuotaPercentage | Integer | No | Disk quota threshold (in percentage) for triggering the message retention time change event Note: null may be returned for this field, indicating that no valid values can be obtained. |
| StepForwardPercentage | Integer | No | Percentage by which the message retention time is shortened each time Note: null may be returned for this field, indicating that no valid values can be obtained. |
| BottomRetention | Integer | No | Minimum retention time, in minutes Note: null may be returned for this field, indicating that no valid values can be obtained. |
Filter
Query filter.
Describes the key-value pair filter, which is used for conditional filtering queries. for example, filter by ID, name, and status.
If there are multiple filters, the logical relationship between them is AND.
If the same Filter contains multiple Values, the relationship between Values under the same Filter is logical OR.
Used by actions: DescribeGroup, DescribeInstancesDetail, DescribeTopicDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Field to be filtered. |
| Values | Array of String | Yes | Filter value of field. |
Group
Group entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| GroupName | String | Consumer group name. |
GroupInfoMember
Consumer information
Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.
| Name | Type | Description |
|---|---|---|
| MemberId | String | Unique ID generated for consumer in consumer group by coordinator |
| ClientId | String | client.id information by the client consumer SDK |
| ClientHost | String | Generally stores client IP address |
| Assignment | Assignment | Stores the information of partition assigned to this consumer |
GroupInfoResponse
GroupInfo response data entity
Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.
| Name | Type | Description |
|---|---|---|
| ErrorCode | String | Error code. 0: success |
| State | String | Group status description (common valid values: Empty, Stable, Dead): Dead: the consumer group does not exist Empty: there are currently no consumer subscriptions in the consumer group PreparingRebalance: the consumer group is currently in rebalance stateCompletingRebalance: the consumer group is currently in rebalance stateStable: each consumer in the consumer group has joined and is in stable state |
| ProtocolType | String | The type of protocol selected by the consumer group, which is consumer for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is connect. Only with the standard consumer protocol can this API get to know the specific assigning method and parse the specific partition assignment |
| Protocol | String | Consumer partition assignment algorithm, such as range (which is the default value for the Kafka consumer SDK), roundrobin, and sticky |
| Members | Array of GroupInfoMember | This array contains information only if state is Stable and protocol_type is consumer |
| Group | String | Consumer group name. |
GroupInfoTopics
Internal topic object of GroupInfo
Used by actions: DescribeGroupInfo, DescribeTopicSubscribeGroup.
| Name | Type | Description |
|---|---|---|
| Topic | String | Name of assigned topics |
| Partitions | Array of Integer | Allocates partition info. |
GroupOffsetPartition
Group offset partition object
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| Partition | Integer | Topic partitionId |
| Offset | Integer | Offset position submitted by consumer |
| Metadata | String | Supports consumers to submit messages with imported metadata for other purposes, currently an empty string. |
| ErrorCode | Integer | Error code |
| LogEndOffset | Integer | Latest offset of current partition |
| Lag | Integer | Number of unconsumed messages |
GroupOffsetResponse
Returned result of consumer group offset
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible results |
| TopicList | Array of GroupOffsetTopic | The topic partition array, where each element is a json object. |
GroupOffsetTopic
Consumer group topic object
Used by actions: DescribeGroupOffsets.
| Name | Type | Description |
|---|---|---|
| Topic | String | Topic name |
| Partitions | Array of GroupOffsetPartition | The topic partition array, where each element is a json object. |
GroupResponse
DescribeGroup response
Used by actions: DescribeGroup.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Counting. |
| GroupList | Array of DescribeGroup | GroupList |
| GroupCountQuota | Integer | Specifies the consumer group quota. |
InquireCkafkaPriceResp
Values returned by the InquireCkafkaPrice API
Used by actions: InquireCkafkaPrice.
| Name | Type | Description |
|---|---|---|
| InstancePrice | InquiryPrice | Specifies the instance price. |
| PublicNetworkBandwidthPrice | InquiryPrice | Public network bandwidth price Note: This field may return null, indicating that no valid values can be obtained. |
InquiryBasePrice
Response parameters for instance price query
Used by actions: InquireCkafkaPrice.
| Name | Type | Description |
|---|---|---|
| UnitPrice | Float | Original price unit. |
| UnitPriceDiscount | Float | Discount unit price. |
| OriginalPrice | Float | Total original price. |
| DiscountPrice | Float | Total discount price. |
| Discount | Float | Discount (unit: %). |
| GoodsNum | Integer | Number of purchased items Note: This field may return null, indicating that no valid values can be obtained. |
| Currency | String | Currency for payment Note: This field may return null, indicating that no valid values can be obtained. |
| DiskType | String | Dedicated disk response parameter Note: This field may return null, indicating that no valid values can be obtained. |
| TimeSpan | Integer | Validity period Note: This field may return null, indicating that no valid values can be obtained. |
| TimeUnit | String | Unit of the validity period (m: Month; h: Hour)Note: This field may return null, indicating that no valid values can be obtained. |
| Value | Integer | Purchase quantity. |
InquiryDetailPrice
Prices of different purchased items
Used by actions: InquireCkafkaPrice.
| Name | Type | Description |
|---|---|---|
| BandwidthPrice | InquiryBasePrice | Price of additional private network bandwidth Note: This field may return null, indicating that no valid values can be obtained. |
| DiskPrice | InquiryBasePrice | Disk price Note: This field may return null, indicating that no valid values can be obtained. |
| PartitionPrice | InquiryBasePrice | Price of additional partitions Note: This field may return null, indicating that no valid values can be obtained. |
| TopicPrice | InquiryBasePrice | Price of additional topics Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceTypePrice | InquiryBasePrice | Instance package price. |
InquiryDiskParam
Disk purchase parameters
Used by actions: InquireCkafkaPrice.
| Name | Type | Required | Description |
|---|---|---|---|
| DiskType | String | No | Disk type. Valid values: SSD (SSD), CLOUD_SSD (SSD cloud disk), CLOUD_PREMIUM (Premium cloud disk), CLOUD_BASIC (Cloud disk). |
| DiskSize | Integer | No | Size of the purchased disk in GB |
InquiryPrice
Response parameters for instance price query
Used by actions: InquireCkafkaPrice.
| Name | Type | Description |
|---|---|---|
| UnitPrice | Float | Original price unit. |
| UnitPriceDiscount | Float | Discount unit price. |
| OriginalPrice | Float | Total original price. |
| DiscountPrice | Float | Total discount price. |
| Discount | Float | Discount (unit: %). |
| GoodsNum | Integer | Number of products |
| Currency | String | Specifies the payment currency. |
| DiskType | String | Dedicated disk response parameter Note: This field may return null, indicating that no valid values can be obtained. |
| TimeSpan | Integer | Purchase duration. |
| TimeUnit | String | Specifies the purchase duration unit ("m" for monthly, "h" for hourly). |
| Value | Integer | Purchase quantity Note: This field may return null, indicating that no valid values can be obtained. |
| DetailPrices | InquiryDetailPrice | Prices of different purchased items Note: This field may return null, indicating that no valid values can be obtained. |
InquiryPublicNetworkParam
Public network bandwidth parameters
Used by actions: InquireCkafkaPrice.
| Name | Type | Required | Description |
|---|---|---|---|
| PublicNetworkChargeType | String | No | Public network bandwidth billing mode (BANDWIDTH_PREPAID: Monthly subscription; BANDWIDTH_POSTPAID_BY_HOUR: Bill-by-hour) |
| PublicNetworkMonthly | Integer | No | Public network bandwidth, in MB. value must be 0 or a multiple of 3. |
Instance
Instance object
Used by actions: DescribeInstances, DescribeTypeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | The ckafka cluster instance Id. |
| InstanceName | String | Specifies the Name of the ckafka cluster instance. |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting, 3: deleted, 5: isolated, 7: upgrading, -1: creation failed. |
| IfCommunity | Boolean | Specifies whether the instance is open-source. valid values: true (open-source), false (not open-source). |
InstanceAttributesResponse
Returned result object of instance attributes
Used by actions: DescribeInstanceAttributes.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | The ckafka cluster instance Id. |
| InstanceName | String | Specifies the Name of the ckafka cluster instance. |
| VipList | Array of VipEntity | VIP list information of access point |
| Vip | String | Virtual IP |
| Vport | String | Virtual port |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting, 3: deleted, 5: isolated, 7: upgrading, -1: creation failed. |
| Bandwidth | Integer | Instance bandwidth in Mbps |
| DiskSize | Integer | Instance storage capacity in GB |
| ZoneId | Integer | AZ |
| VpcId | String | VPC ID. If this parameter is empty, it means the basic network |
| SubnetId | String | Subnet ID. If this parameter is empty, it means the basic network |
| Healthy | Integer | Instance health status. 1: healthy, 2: alarmed, 3: exceptional |
| HealthyMessage | String | Instance health information. Currently, the disk utilization is displayed with a maximum length of 256 |
| CreateTime | Integer | Creation time |
| MsgRetentionTime | Integer | Message retention period in minutes |
| Config | InstanceConfigDO | Configuration for automatic topic creation. If this field is empty, it means that automatic creation is not enabled |
| RemainderPartitions | Integer | Number of remaining creatable partitions |
| RemainderTopics | Integer | Number of remaining creatable topics |
| CreatedPartitions | Integer | Number of partitions already created |
| CreatedTopics | Integer | Number of topics already created |
| Tags | Array of Tag | Tag array |
| ExpireTime | Integer | Expiration time |
| ZoneIds | Array of Integer | Availability Zone List |
| Version | String | Specifies the ckafka cluster instance version. |
| MaxGroupNum | Integer | Maximum number of groups. |
| Cvm | Integer | Sale type. valid values: 0 (standard version), 1 (pro edition). |
| InstanceType | String | Instance type. valid values:. Specifies the pro edition. Standard version. premium. specifies the advanced edition. Specifies the serverless version. |
| Features | Array of String | Indicates the characteristics supported by the instance. FEATURE_SUBNET_ACL means the policy support for configuring subnets. |
| RetentionTimeConfig | DynamicRetentionTime | Dynamic message retention policy. |
| MaxConnection | Integer | Maximum number of connections. |
| PublicNetwork | Integer | Public network bandwidth |
| DeleteRouteTimestamp | String | Specifies the deprecated field with no actual meaning. |
| RemainingPartitions | Integer | Number of remaining creatable partitions. |
| RemainingTopics | Integer | Number of remaining creatable topics. |
| DynamicDiskConfig | DynamicDiskConfig | Scaling policy for dynamic disk. |
| SystemMaintenanceTime | String | Specifies the system maintenance time. |
| MaxMessageByte | Integer | Specifies the maximum size of messages at the instance level. |
| InstanceChargeType | String | Specifies the instance billing type. POSTPAID_BY_HOUR: hourly billing; PREPAID: annual/monthly package. |
| ElasticBandwidthSwitch | Integer | Whether to enable the elastic bandwidth allowlist. Indicates the allowlist feature with elastic bandwidth enabled. 0: elastic bandwidth allowlist feature is disabled. |
| ElasticBandwidthOpenStatus | Integer | Indicates the elastic bandwidth activation status. 1: indicates elastic bandwidth is disabled. Enable elastic bandwidth. Enable elastic bandwidth successfully. 33: disabling elastic bandwidth. Indicates that the elastic bandwidth is successfully disabled. Enable elastic bandwidth failed. Bandwidth failure. |
| ClusterType | String | Cluster type. CLOUD_IDC idc cluster. CLOUD_CVM_SHARE shared cluster. CLOUD_CVM_YUNTI yunti cvm cluster. CLOUD_CVM. specifies the cvm cluster. CLOUD_CDC cdc cluster. CLOUD_EKS_TSE eks cluster. |
| FreePartitionNumber | Integer | Number of free partitions. |
| ElasticFloatBandwidth | Integer | Specifies the elastic bandwidth upper limit. |
| CustomCertId | String | ssl custom certificate id. only returned for instance clusters with custom certificates. |
| UncleanLeaderElectionEnable | Integer | Default unclean.leader.election.enable configuration for cluster topic: 1 enable 0 disable. |
| DeleteProtectionEnable | Integer | Instance deletion protection switch. 1: enabled; 0: disabled. |
InstanceChargeParam
Instance billing parameters
Used by actions: InquireCkafkaPrice.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceChargeType | String | No | Instance billing mode (PREPAID: Monthly subscription; POSTPAID_BY_HOUR: Pay-as-you-go) |
| InstanceChargePeriod | Integer | No | Validity period, which is only required for the monthly subscription billing mode |
InstanceConfigDO
Instance configuration entity
Used by actions: DescribeInstanceAttributes.
| Name | Type | Description |
|---|---|---|
| AutoCreateTopicsEnable | Boolean | Whether to create topics automatically |
| DefaultNumPartitions | Integer | Number of partitions |
| DefaultReplicationFactor | Integer | Default replication factor |
InstanceDeleteResponse
Deletion of instances returns a task.
Used by actions: DeleteInstancePost.
| Name | Type | Description |
|---|---|---|
| FlowId | Integer | Specifies the task Id returned after deleting an instance. |
InstanceDetail
Instance details
Used by actions: DescribeInstancesDetail.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | The ckafka cluster instance Id. |
| InstanceName | String | CKafka cluster instance name. |
| Vip | String | Instance VIP information |
| Vport | String | Instance port information |
| VipList | Array of VipEntity | Virtual IP list |
| Status | Integer | Instance status. 0: creating, 1: running, 2: deleting, 3: deleted, 5: isolated, 7: upgrading, -1: creation failed. |
| Bandwidth | Integer | Instance bandwidth in Mbps |
| DiskSize | Integer | Specifies the ckafka cluster instance disk size in gb. |
| ZoneId | Integer | AZ ID |
| VpcId | String | vpcId. If this parameter is empty, it means the basic network |
| SubnetId | String | Subnet ID |
| RenewFlag | Integer | Whether to renew the instance automatically, which is an int-type enumerated value. 1: yes, 2: no |
| Healthy | Integer | Instance status. An int-type value will be returned. 0: Healthy, 1: Alarmed, 2: Exceptional |
| HealthyMessage | String | Instance status information |
| CreateTime | Integer | Instance creation time |
| ExpireTime | Integer | Instance expiration time |
| IsInternal | Integer | Whether it is an internal customer. 1: yes |
| TopicNum | Integer | Number of topics |
| Tags | Array of Tag | Tag |
| Version | String | kafka version information. |
| ZoneIds | Array of Integer | Cross-Availability zone. |
| Cvm | Integer | ckafka sales type. |
| InstanceType | String | Specifies the cluster instance type of ckafka. |
| DiskType | String | Specifies the ckafka cluster instance disk type. |
| MaxTopicNumber | Integer | Maximum number of topics for current specifications. |
| MaxPartitionNumber | Integer | Maximum number of partitions for current specifications. |
| RebalanceTime | String | Scheduled configuration upgrade time. |
| PartitionNumber | Integer | Specifies the number of partitions in the current instance. |
| PublicNetworkChargeType | String | Specifies the public network bandwidth type of the ckafka cluster instance. |
| PublicNetwork | Integer | Public network bandwidth. minimum 3 Mbps. maximum 999 Mbps. only the pro edition supports filling in. |
| ClusterType | String | Specifies the underlying cluster type of the ckafka cluster instance. |
| Features | Array of String | Instance feature list. |
InstanceDetailResponse
Returned result of instance details
Used by actions: DescribeInstancesDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible instances |
| InstanceList | Array of InstanceDetail | List of eligible instance details |
InstanceQuotaConfigResp
Traffic throttling policy in instance/topic dimension
Used by actions: DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| QuotaProducerByteRate | Integer | Production throttling in MB/sec. Note: This field may return null, indicating that no valid values can be obtained. |
| QuotaConsumerByteRate | Integer | Consumption throttling in MB/sec. Note: This field may return null, indicating that no valid values can be obtained. |
InstanceResponse
Aggregated returned result of instance status
Used by actions: DescribeInstances, DescribeTypeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of Instance | Specifies the list of instances meeting the conditions. |
| TotalCount | Integer | Total results that meet the conditions. |
InstanceRoute
Instance route.
Used by actions: DescribeSecurityGroupRoutes.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | Yes | The ckafka cluster instance Id. |
| RouteId | Integer | Yes | Route ID |
JgwOperateResponse
Returned result value of operation
Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreatePartition, CreateRoute, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteGroup, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyRoutineMaintenanceTask, ModifyTopicAttributes, UpgradeBrokerVersion.
| Name | Type | Description |
|---|---|---|
| ReturnCode | String | Returned code. 0: normal, other values: error |
| ReturnMessage | String | Success message |
| Data | OperateResponseData | Data returned by an operation, which may contain flowId, etc.Note: this field may return null, indicating that no valid values can be obtained. |
ListCvmAndIpInfoRsp
CVM and IP information list.
Used by actions: DescribeCvmInfo.
| Name | Type | Description |
|---|---|---|
| CvmList | Array of CvmAndIpInfo | cvm and IP list. |
| TotalCount | Integer | Specifies the instance data volume. |
ModifyInstanceAttributesConfig
Configuration object for modifying instance attributes
Used by actions: ModifyInstanceAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| AutoCreateTopicEnable | Boolean | No | Automatic creation. true: enabled, false: not enabled |
| DefaultNumPartitions | Integer | No | Default number of partitions for a newly created topic. if AutoCreateTopicEnable is set to true and no value is set, defaults to 3. |
| DefaultReplicationFactor | Integer | No | Default number of replicas for a newly created topic. if AutoCreateTopicEnable is set to true and not specified, defaults to 2. |
OperateResponseData
Data structure returned by operation
Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreatePartition, CreateRoute, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteGroup, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyRoutineMaintenanceTask, ModifyTopicAttributes, UpgradeBrokerVersion.
| Name | Type | Description |
|---|---|---|
| FlowId | Integer | Flow ID. |
| RouteDTO | RouteDTO | RouteIdDto |
Partition
Partition entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| PartitionId | Integer | Partition ID |
PartitionOffset
Partition and offset
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| Partition | String | Partition |
| Offset | Integer | Specifies the offset. |
Partitions
Partition information
Used by actions: BatchModifyGroupOffsets.
| Name | Type | Required | Description |
|---|---|---|---|
| Partition | Integer | Yes | Partition. |
| Offset | Integer | Yes | Partition consumption offset. |
Price
Message price entity
Used by actions: DescribeCkafkaZone.
| Name | Type | Description |
|---|---|---|
| RealTotalCost | Float | Discounted price |
| TotalCost | Float | Original price |
Region
Region entity object
Used by actions: DescribeRegion.
| Name | Type | Description |
|---|---|---|
| RegionId | Integer | Region ID |
| RegionName | String | Region name |
| AreaName | String | Area name |
| RegionCode | String | Region code. |
| RegionCodeV3 | String | Region code (V3 version). |
| Support | String | Specifies the default value does not support any special type instance type. |
| Ipv6 | Integer | Whether ipv6 is supported. 0: indicates no support. 1: indicates support. |
| MultiZone | Integer | Whether cross-az is supported. valid values: 0 (unsupported), 1 (supported). |
Route
Route entity object
Used by actions: DescribeRoute.
| Name | Type | Description |
|---|---|---|
| AccessType | Integer | Instance connection method 0: PLAINTEXT (plaintext method, which does not carry user information and is supported for legacy versions and Community Edition) 1: SASL_PLAINTEXT (plaintext method, which authenticates the login through SASL before data start and is supported only for Community Edition) 2: SSL (SSL-encrypted communication, which does not carry user information and is supported for legacy versions and Community Edition) 3: SASL_SSL (SSL-encrypted communication, which authenticates the login through SASL before data start and is supported only for Community Edition) |
| RouteId | Integer | Route ID |
| VipType | Integer | Specifies the network type of the route (3: vpc routing; 7: internal support route; 1: public network route). |
| VipList | Array of VipEntity | Virtual IP list |
| Domain | String | Domain name Note: this field may return null, indicating that no valid values can be obtained. |
| DomainPort | Integer | Domain name port Note: this field may return null, indicating that no valid values can be obtained. |
| DeleteTimestamp | String | Timestamp. |
| Subnet | String | Specifies the subnet Id. Note: This field may return null, indicating that no valid values can be obtained. |
| BrokerVipList | Array of VipEntity | Virtual IP list (1:1 broker node). |
| VpcId | String | VPC Id. specifies the Id of the vpc. Note: This field may return null, indicating that no valid values can be obtained. |
| Note | String | Remarks Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Route status. 1: creating, 2: creation succeeded, 3: creation failed, 4: deleting, 6: deletion failed. Note: This field may return null, indicating that no valid values can be obtained. |
RouteDTO
RouteDTO
Used by actions: BatchModifyGroupOffsets, CreateAcl, CreateConsumer, CreatePartition, CreateRoute, CreateTopicIpWhiteList, CreateUser, DeleteAcl, DeleteGroup, DeleteRoute, DeleteTopic, DeleteTopicIpWhiteList, DeleteUser, ModifyDatahubTopic, ModifyGroupOffsets, ModifyInstanceAttributes, ModifyPassword, ModifyRoutineMaintenanceTask, ModifyTopicAttributes, UpgradeBrokerVersion.
| Name | Type | Description |
|---|---|---|
| RouteId | Integer | Route ID |
RouteFilter
Routing list filter.
Used by actions: DescribeSecurityGroupRoutes.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Filters by name. currently supports security-group-id. filters by security group association. |
| Values | Array of String | No | Filter value. when the filter name is security-group-id, only supports transmission of one value. |
| Relation | String | No | Filter relationship. supports IN and NOT_IN. default is IN. |
RouteResponse
Returned object for route information
Used by actions: DescribeRoute.
| Name | Type | Description |
|---|---|---|
| Routers | Array of Route | Route Information List |
SaleInfo
Sales information of versions.
Used by actions: DescribeCkafkaZone.
| Name | Type | Description |
|---|---|---|
| Flag | Boolean | The manually configured flag. valid values: true (sold-out), false (available). |
| Version | String | Specifies the ckafka version number (1.1.1/2.4.2/0.10.2). |
| Platform | String | Pro edition, standard version flag. |
| SoldOut | Boolean | Specifies whether the item is sold-out. valid values: true (sold-out). |
ScalingDownResp
Instance downsizing response.
Used by actions: InstanceScalingDown.
| Name | Type | Description |
|---|---|---|
| DealNames | Array of String | Order ID list |
SecurityGroupRoute
Security group routing information.
Used by actions: DescribeSecurityGroupRoutes.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceRoute | InstanceRoute | No | Specifies the routing information. |
| SecurityGroupIds | Array of String | No | Specifies the security group list to associate. |
| InstanceName | String | No | CKafka cluster instance name. |
| VpcId | String | No | Specifies the route vpcId. |
| Vip | String | No | Route vip. |
SecurityGroupRouteResp
Security group routing information returned results.
Used by actions: DescribeSecurityGroupRoutes.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible security group routes. |
| SecurityGroupRoutes | Array of SecurityGroupRoute | Eligible security group route information list. |
SubscribedInfo
Subscribed message entity
Used by actions: DescribeConsumerGroup.
| Name | Type | Description |
|---|---|---|
| TopicName | String | Subscribed topic name |
| Partition | Array of Integer | Specifies the subscription partition. |
| PartitionOffset | Array of PartitionOffset | Specifies the partition offset information. |
| TopicId | String | Subscribed topic ID. |
Tag
Tag object in instance details
Used by actions: CreateDatahubTopic, CreateInstancePre, CreatePostPaidInstance, CreateTopic, DescribeInstanceAttributes, DescribeInstancesDetail, DescribeTopicDetail, ModifyDatahubTopic, ModifyTopicAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
TaskStatusResponse
Returned task status
Used by actions: DescribeTaskStatus.
| Name | Type | Description |
|---|---|---|
| Status | Integer | Task status. 0 (Successful), 1 (Failed), 2 ( Running) |
| Output | String | Output information. |
Topic
Returned topic object
Used by actions: DescribeTopic.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| TopicName | String | Topic name |
| Note | String | Remarks Note: this field may return null, indicating that no valid values can be obtained. |
TopicAttributesResponse
Returned topic attributes result entity
Used by actions: DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| TopicId | String | Topic ID |
| CreateTime | Integer | Specifies the unix second-level timestamp of the creation time. |
| Note | String | Describes the topic remark. |
| PartitionNum | Integer | Number of partitions |
| EnableWhiteList | Integer | IP allowlist switch. 1: enabled, 0: disabled |
| IpWhiteList | Array of String | IP allowlist list |
| Config | Config | Topic configuration array |
| Partitions | Array of TopicPartitionDO | Partition details |
| EnableAclRule | Integer | ACL preset policy switch. valid values: 1 (on); 0 (off). |
| AclRuleList | Array of AclRule | Preset policy list. |
| QuotaConfig | InstanceQuotaConfigResp | topic throttling policy. |
| ReplicaNum | Integer | Number of replicas |
TopicDetail
Topic details
Used by actions: DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| TopicName | String | Topic name |
| TopicId | String | Topic Id. |
| PartitionNum | Integer | Number of partitions |
| ReplicaNum | Integer | Number of topic replicas. valid values: 1, 3. |
| Note | String | Remarks. |
| CreateTime | Integer | Creation time |
| EnableWhiteList | Boolean | Whether to enable IP authentication allowlist. true: yes, false: no |
| IpWhiteListCount | Integer | Number of IPs in IP allowlist |
| ForwardCosBucket | String | Data backup cos bucket. specifies the bucket address for archiving to cos. |
| ForwardStatus | Integer | Status of data backup to COS. 1: not enabled, 0: enabled |
| ForwardInterval | Integer | Frequency of data backup to COS |
| Config | Config | Advanced configuration. |
| RetentionTimeConfig | TopicRetentionTimeConfigRsp | Message retention period configuration (used for dynamic configuration change records). |
| Status | Integer | 0: normal. 1: deleted. 2: deleting. |
| Tags | Array of Tag | Tag list Note: This field may return null, indicating that no valid values can be obtained. |
TopicDetailResponse
Returned topic details entity
Used by actions: DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| TopicList | Array of TopicDetail | List of returned topic details. |
| TotalCount | Integer | Number of all eligible topic details |
TopicInSyncReplicaInfo
Topic replica and details
Used by actions: DescribeTopicSyncReplica.
| Name | Type | Description |
|---|---|---|
| Partition | String | Partition name |
| Leader | Integer | Leader ID |
| Replica | String | Replica set |
| InSyncReplica | String | ISR |
| BeginOffset | Integer | Start Offset. |
| EndOffset | Integer | End Offset. |
| MessageCount | Integer | Message count. |
| OutOfSyncReplica | String | Unsynced replica. |
TopicInSyncReplicaResult
Set of topic replicas and details
Used by actions: DescribeTopicSyncReplica.
| Name | Type | Description |
|---|---|---|
| TopicInSyncReplicaList | Array of TopicInSyncReplicaInfo | Set of topic details and replicas |
| TotalCount | Integer | Total number |
TopicPartitionDO
Partition details
Used by actions: DescribeTopicAttributes.
| Name | Type | Description |
|---|---|---|
| Partition | Integer | Partition ID. specifies the Partition ID. |
| LeaderStatus | Integer | Leader running status. 0 means running normally. |
| IsrNum | Integer | ISR quantity |
| ReplicaNum | Integer | Number of replicas |
TopicResult
TopicResponse returned uniformly
Used by actions: DescribeTopic.
| Name | Type | Description |
|---|---|---|
| TopicList | Array of Topic | List of returned topic information. |
| TotalCount | Integer | Number of eligible topics. |
TopicRetentionTimeConfigRsp
Information returned for topic message retention time configuration
Used by actions: DescribeTopicDetail.
| Name | Type | Description |
|---|---|---|
| Expect | Integer | Expected value, the message retention period (in minutes) set by user configuration. |
| Current | Integer | Current value, which is the current effective value (may contain dynamic adjustment in minutes). |
| ModTimeStamp | Integer | Last modified time. |
TopicSubscribeGroup
DescribeTopicSubscribeGroup output parameters
Used by actions: DescribeTopicSubscribeGroup.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| StatusCountInfo | String | Number of consumer group status |
| GroupsInfo | Array of GroupInfoResponse | Consumer group information. |
| Status | Integer | Indicates whether the request is asynchronous. instances with fewer groups will return results directly with Status as 1. when there are more groups, the cache will be updated asynchronously. no group information will be returned when Status is 0 until the update is complete and results are returned with Status as 1. |
User
User entity
Used by actions: DescribeUser.
| Name | Type | Description |
|---|---|---|
| UserId | Integer | User ID |
| Name | String | Username |
| CreateTime | Timestamp | Creation time |
| UpdateTime | Timestamp | Last updated time |
UserResponse
Returned user entity
Used by actions: DescribeUser.
| Name | Type | Description |
|---|---|---|
| Users | Array of User | Specifies the eligible users list. |
| TotalCount | Integer | Total number of eligible users |
VipEntity
Virtual IP entity
Used by actions: DescribeInstanceAttributes, DescribeInstancesDetail, DescribeRoute.
| Name | Type | Description |
|---|---|---|
| Vip | String | Virtual IP |
| Vport | String | Virtual port |
ZoneInfo
Zone information entity
Used by actions: DescribeCkafkaZone.
| Name | Type | Description |
|---|---|---|
| ZoneId | String | Availability zone |
| IsInternalApp | Integer | Whether it is an internal application. |
| AppId | Integer | Application identifier |
| Flag | Boolean | Indicates whether the AZ is sold out. true indicates sold out. false indicates not sold out. |
| ZoneName | String | Availability zone name. |
| ZoneStatus | Integer | Availability zone status. enumerates example: 3: enable, 4: disable. availability zone status is subject to SoldOut. |
| SoldOut | String | Specifies whether the item is sold-out. valid values: true (sold-out), false (not sold out). |
| SalesInfo | Array of SaleInfo | Specifies the sell-out information of the standard version. |
| ExtraFlag | String | Additional flag. |
ZoneResponse
The entity returned for the query of Kafka’s zone information
Used by actions: DescribeCkafkaZone.
| Name | Type | Description |
|---|---|---|
| ZoneList | Array of ZoneInfo | Specifies the zone list. . |
| MaxBuyInstanceNum | Integer | Maximum number of instances that can be purchased. . |
| MaxBandwidth | Integer | Maximum purchase bandwidth in Mb/s. . |
| UnitPrice | Price | Unit price for postpayment. . |
| MessagePrice | Price | Message unit price for postpayment. . |
| ClusterInfo | Array of ClusterInfo | User-Exclusive cluster information. . |
| Standard | String | Specifies the standard version configuration to purchase. . |
| StandardS2 | String | Specifies the purchase of standard version s2 configuration. . |
| Profession | String | Specifies the configuration for purchasing professional edition. . |
| Physical | String | Purchase physical dedicated edition configuration. . |
| PublicNetwork | String | Specifies the public network bandwidth. valid values: 3Mbps to 999Mbps. only supported in pro edition. abandoned, meaningless. . |
| PublicNetworkLimit | String | Public network bandwidth configuration. . |
| RequestId | String | Request Id. . |
| Offset | Integer | Specifies the pagination offset. . |
| Limit | Integer | Specifies the pagination limit. . |
| ForceCheckTag | Boolean | Specifies whether the tag is mandatory. . |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback