Data Types

Last updated: 2021-05-26 17:44:11

CcnInfo

CCN information

Used by actions: CopyFleet.

Name Type Required Description
AccountId String Yes Account of the CCN instance owner
CcnId String Yes CCN ID

Credentials

Credentials required for instance access

Used by actions: GetInstanceAccess.

Name Type Description
Secret String SSH private key
UserName String Username

DesiredPlayerSession

Player game session information

Used by actions: StartGameServerSessionPlacement.

Name Type Required Description
PlayerId String Yes Unique player ID associated with player session
PlayerData String Yes Developer-defined player data

DiskInfo

Disk storage information

Used by actions: CopyFleet.

Name Type Required Description
DiskType String Yes Disk type: Premium Cloud Storage (CLOUD_PREMIUM) or SSD (CLOUD_SSD)
DiskSize Integer Yes System disk: the available disk capacity is 50-500 GB. Data disk: the available disk capacity is 100-32000 GB, and the value is a multiple of 10. When the disk type is SSD (CLOUD_SSD), the minimum capacity is 100 GB.

FleetAttributes

Service deployment attributes

Used by actions: CopyFleet.

Name Type Description
AssetId String Asset package ID
CreationTime String Server fleet creation time
Description String Description
Note: this field may return null, indicating that no valid value is obtained.
FleetArn String Description of server fleet resource
Note: this field may return null, indicating that no valid value is obtained.
FleetId String Server fleet ID
Note: this field may return null, indicating that no valid value is obtained.
FleetType String Server fleet type, which only supports ON_DEMAND now.
Note: this field may return null, indicating that no valid value is obtained.
InstanceType String Server type, such as S5.LARGE8
Note: this field may return null, indicating that no valid value is obtained.
Name String Server fleet name
NewGameServerSessionProtectionPolicy String Game session protection policy
Note: this field may return null, indicating that no valid value is obtained.
OperatingSystem String Operating system type
Note: this field may return null, indicating that no valid value is obtained.
ResourceCreationLimitPolicy ResourceCreationLimitPolicy Limit policy of resource creation
Note: this field may return null, indicating that no valid value is obtained.
Status String Statuses: “Create”, “Downloading”, “Verifying”, “Generating”, “Activating”, “Active”, “Exception”, “Deleting”, and “End”.
Note: this field may return null, indicating that no valid value is obtained.
StoppedActions Array of String The status of server fleet when it stopped. If this field is left empty, it means automatic scaling.
Note: this field may return null, indicating that no valid value is obtained.
TerminationTime String Server fleet termination time
Note: this field may return null, indicating that no valid value is obtained.
GameServerSessionProtectionTimeLimit Integer Timeout period of time-limited protection. Value range: 5-1440 minutes. Default value: 60 minutes.
Note: this field may return null, indicating that no valid value is obtained.
BillingStatus String Billing status: Unactivated, Activated, Exception, Isolated due to arrears, Terminated, and Unfrozen.
Note: this field may return null, indicating that no valid value is obtained.
Tags Array of Tag Tag list. Up to 50 tags.
Note: this field may return null, indicating that no valid value is obtained.
DataDiskInfo Array of DiskInfo Data disk. It can be SSD disks (CLOUD_SSD) with 100-32000 GB capacity or Premium Cloud Storage disks (CLOUD_PREMIUM) with 10-32000 GB capacity. The increment is 10.
Note: this field may return null, indicating that no valid value is obtained.
SystemDiskInfo DiskInfo System disk. It can be a SSD (CLOUD_SSD) with 100-500 GB capacity or a Premium Cloud Storage disk (CLOUD_PREMIUM) with 50-500 GB capacity. The increment is 1.
Note: this field may return null, indicating that no valid value is obtained.
RelatedCcnInfos Array of RelatedCcnInfo CCN instance information
Note: this field may return null, indicating that no valid value is obtained.
InternetMaxBandwidthOut Integer Maximum outbound public network bandwidth of the server fleet. Value range: 1 - 200 Mbps. Default value: 100 Mbps.
Note: this field may return null, indicating that no valid values can be obtained.

GameProperty

Game attribute details

Used by actions: CreateGameServerSession, DescribeGameServerSessionDetails, DescribeGameServerSessionPlacement, DescribeGameServerSessions, SearchGameServerSessions, StartGameServerSessionPlacement, StopGameServerSessionPlacement, UpdateGameServerSession.

Name Type Description
Key String Attribute name. Up to 32 ASCII characters are allowed.
Value String Attribute value. Up to 96 ASCII characters are allowed.

GameServerSession

Game session details

Used by actions: CreateGameServerSession, DescribeGameServerSessionDetails, DescribeGameServerSessions, SearchGameServerSessions, UpdateGameServerSession.

Name Type Description
CreationTime String Game server session creation time
CreatorId String Creator ID. Up to 1024 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
CurrentPlayerSessionCount Integer The current number of players, which cannot be less than 0.
DnsName String CVM DNS ID
Note: this field may return null, indicating that no valid values can be obtained.
FleetId String Fleet ID
GameProperties Array of GameProperty Game attributes. Up to 16 groups of attributes are allowed.
Note: this field may return null, indicating that no valid value is obtained.
GameServerSessionData String The attribute details of game server session. Up to 4096 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
GameServerSessionId String Game server session ID. It should contain 1 to 48 ASCII characters.
IpAddress String CVM IP address
MatchmakerData String Battle progress details. Up to 400,000 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
MaximumPlayerSessionCount Integer The maximum number of players, which cannot be less than 0.
Name String The name of game server session. Up to 1024 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
PlayerSessionCreationPolicy String Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL
Note: this field may return null, indicating that no valid value is obtained.
Port Integer Port number. It should be a value between 1 to 60000.
Status String Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR
StatusReason String Additional information of game server session status
Note: this field may return null, indicating that no valid values can be obtained.
TerminationTime String Termination time
Note: this field may return null, indicating that no valid values can be obtained.
InstanceType String Instance type. Up to 128 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
CurrentCustomCount Integer Current custom count
Note: this field may return null, indicating that no valid values can be obtained.
MaxCustomCount Integer Maximum custom count
Note: this field may return null, indicating that no valid values can be obtained.
Weight Integer Weight
Note: this field may return null, indicating that no valid values can be obtained.
AvailabilityStatus String Session availability status, i.e., whether it is blocked. Valid value: Enable, Disable
Note: this field may return null, indicating that no valid value is obtained.

GameServerSessionDetail

Game server session details (GameServerSessionDetail)

Used by actions: DescribeGameServerSessionDetails.

Name Type Description
GameServerSession GameServerSession Game server session
ProtectionPolicy String Protection policy. Valid values: NoProtection, FullProtection
Note: this field may return null, indicating that no valid values can be obtained.

GameServerSessionPlacement

Game session deployment object

Used by actions: DescribeGameServerSessionPlacement, StartGameServerSessionPlacement, StopGameServerSessionPlacement.

Name Type Description
PlacementId String Deployment ID
GameServerSessionQueueName String Service deployment group name
PlayerLatencies Array of PlayerLatency Player latency
Note: this field may return null, indicating that no valid values can be obtained.
Status String Service deployment status
DnsName String DNS ID assigned to the instance where the game session is running
Note: this field may return null, indicating that no valid values can be obtained.
GameServerSessionId String Game session ID
Note: this field may return null, indicating that no valid values can be obtained.
GameServerSessionName String Game session name
Note: this field may return null, indicating that no valid values can be obtained.
GameServerSessionRegion String Service deployment region
Note: this field may return null, indicating that no valid values can be obtained.
GameProperties Array of GameProperty Game attributes
Note: this field may return null, indicating that no valid values can be obtained.
MaximumPlayerSessionCount Integer The maximum number of players that can be connected simultaneously to the game session. It should a value between 1 to the maximum number of player sessions.
GameServerSessionData String Game session data
Note: this field may return null, indicating that no valid values can be obtained.
IpAddress String IP address of the instance where the game session is running
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Port number of the instance where the game session is running
Note: this field may return null, indicating that no valid values can be obtained.
MatchmakerData String Game match data
Note: this field may return null, indicating that no valid values can be obtained.
PlacedPlayerSessions Array of PlacedPlayerSession Deployed player game data
Note: this field may return null, indicating that no valid values can be obtained.
StartTime String Start time
EndTime String End time
Note: this field may return null, indicating that no valid values can be obtained.

InboundPermission

Allowed network range.

Used by actions: CopyFleet.

Name Type Required Description
FromPort Integer No Start port number. Minimum value: 1025.
IpRange String No IP range. Valid range of the input IPv4 addresses in CIDR format; for example, 0.0.0.0.0/0.
Protocol String No Protocol type: TCP or UDP.
ToPort Integer No End port number. Maximum value: 60000.

InstanceAccess

Identity credentials for instance access

Used by actions: GetInstanceAccess.

Name Type Description
Credentials Credentials Credentials required for instance access
FleetId String Service deployment ID
InstanceId String Instance ID
IpAddress String Public IP of instance
OperatingSystem String OS

InstanceTypeInfo

The server instance type information

Used by actions: DescribeInstanceTypes.

Name Type Description
TypeName String Name of the server type, such as Standard SA1
InstanceType String Specification of the server type, such as SA1.SMALL1
Cpu Integer CPU, in core
Memory Integer Memory, in GB
NetworkCard Integer The packet sending and receiving capability, in 10k PPS.

PlacedPlayerSession

Deployed player game session

Used by actions: DescribeGameServerSessionPlacement, StartGameServerSessionPlacement, StopGameServerSessionPlacement.

Name Type Description
PlayerId String Player ID
PlayerSessionId String Player session ID

PlayerDataMap

Player custom data

Used by actions: JoinGameServerSessionBatch.

Name Type Required Description
Key String Yes The key of player custom data. It should contain 1 to 1024 ASCII characters.
Value String Yes The value of player custom data. It should contain 1 to 2048 ASCII characters.

PlayerLatency

Player latency information

Used by actions: DescribeGameServerSessionPlacement, StartGameServerSessionPlacement, StopGameServerSessionPlacement.

Name Type Required Description
PlayerId String No Player ID
Note: this field may return null, indicating that no valid values can be obtained.
RegionIdentifier String No Name of region corresponding to latency
Note: this field may return null, indicating that no valid values can be obtained.
LatencyInMilliseconds Integer No Latency in milliseconds

PlayerSession

Player session details

Used by actions: DescribePlayerSessions, JoinGameServerSession, JoinGameServerSessionBatch.

Name Type Description
CreationTime String Player session creation time
DnsName String ID of the DNS where the game server session is running
Note: this field may return null, indicating that no valid values can be obtained.
FleetId String Fleet ID
GameServerSessionId String Game server session ID. It should contain 1 to 256 ASCII characters.
IpAddress String Address of the CVM instance where the game server session is running
PlayerData String Player custom data. Up to 2048 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
PlayerId String Player ID. Up to 1024 ASCII characters are allowed.
Note: this field may return null, indicating that no valid value is obtained.
PlayerSessionId String Player session ID
Port Integer Port number. It should be a value between 1 to 60000.
Status String Player session status. Valid values: RESERVED = 1, ACTIVE = 2, COMPLETED =3, TIMEDOUT = 4
TerminationTime String Player session termination time
Note: this field may return null, indicating that no valid values can be obtained.

RelatedCcnInfo

Information of the associated CCN instance

Used by actions: CopyFleet.

Name Type Description
AccountId String Account of the CCN instance owner
CcnId String CCN instance ID
AttachType String Status of associated CCN instance

ResourceCreationLimitPolicy

Resource creation policy

Used by actions: CopyFleet.

Name Type Required Description
NewGameServerSessionsPerCreator Integer No Creation quantity. Minimum value: 1. Default value: 2.
PolicyPeriodInMinutes Integer No Unit time. Minimum value: 1. Default value: 3. Unit: minute.

RuntimeConfiguration

Runtime configuration

Used by actions: CopyFleet.

Name Type Required Description
GameServerSessionActivationTimeoutSeconds Integer No Game session timeout. Value range: 1-600. Unit: second.
MaxConcurrentGameServerSessionActivations Integer No Maximum number of game sessions. Value range: 1-2,147,483,647.
ServerProcesses Array of ServerProcesse No Service process configuration. There must be at least one service configuration.

ServerProcesse

Game service process

Used by actions: CopyFleet.

Name Type Required Description
ConcurrentExecutions Integer No Number of concurrent processes. Value range of total concurrent processes: 1-50.
LaunchPath String No Launch Path. Linux: /local/game/ or Windows: C:\game. The path length is 1-1024.
Parameters String No Launch parameter. The length is 0-1024.

Tag

Tag structure

Used by actions: CopyFleet.

Name Type Required Description
Key String Yes Tag key. Up to 127 bytes are allowed.
Value String Yes Tag value. Up to 255 bytes are allowed.

TargetConfiguration

Configuration of target tracking scaling

Used by actions: DescribeTimerScalingPolicies, PutTimerScalingPolicy.

Name Type Required Description
TargetValue Integer No Ratio of reserved server session resource
Note: this field may return null, indicating that no valid values can be obtained.

TimerConfiguration

The recurrence pattern of auto-scaling

Used by actions: DescribeTimerScalingPolicies, PutTimerScalingPolicy.

Name Type Required Description
TimerType Integer No The recurrence pattern of auto-scaling. 0: undefined, 1: once, 2: daily, 3: monthly, 4: weekly
Note: this field may return null, indicating that no valid values can be obtained.
TimerValue TimerValue No Details of the recurrence pattern of auto-scaling
Note: this field may return null, indicating that no valid values can be obtained.
BeginTime String No Start time of the scheduled scaling policy
Note: this field may return null, indicating that no valid values can be obtained.
EndTime String No End time of the scheduled scaling policy
Note: this field may return null, indicating that no valid values can be obtained.

TimerFleetCapacity

The capacity configurations of the scheduled scaling policy

Used by actions: DescribeTimerScalingPolicies, PutTimerScalingPolicy.

Name Type Required Description
FleetId String No ID of the fleet to be bound with the policy
Note: this field may return null, indicating that no valid values can be obtained.
DesiredInstances Integer No Desired number of instances
Note: this field may return null, indicating that no valid values can be obtained.
MinSize Integer No Minimum number of instances
Note: this field may return null, indicating that no valid values can be obtained.
MaxSize Integer No Maximum number of instances
Note: this field may return null, indicating that no valid values can be obtained.
ScalingInterval Integer No Scaling cooldown period, in minutes
Note: this field may return null, indicating that no valid values can be obtained.
ScalingType Integer No Scaling type. 1: manual, 2: automatic, 0: undefined
Note: this field may return null, indicating that no valid values can be obtained.
TargetConfiguration TargetConfiguration No Configuration of target tracking scaling
Note: this field may return null, indicating that no valid values can be obtained.

TimerScalingPolicy

Configurations of a scheduled scaling policy

Used by actions: DescribeTimerScalingPolicies, PutTimerScalingPolicy.

Name Type Required Description
TimerId String No Unique ID of the policy. When it’s filled in, the policy will be updated.
Note: this field may return null, indicating that no valid values can be obtained.
TimerName String No Scheduled scaling policy name
Note: this field may return null, indicating that no valid values can be obtained.
TimerStatus Integer No Scheduled scaling policy status. 0: Undefined, 1: Not started, 2: Activated, 3: Stopped, 4: Expired
Note: this field may return null, indicating that no valid values can be obtained.
TimerFleetCapacity TimerFleetCapacity No The capacity configurations of the scheduled scaling policy
Note: this field may return null, indicating that no valid values can be obtained.
TimerConfiguration TimerConfiguration No The recurrence pattern of auto-scaling
Note: this field may return null, indicating that no valid values can be obtained.

TimerValue

Details of the recurrence pattern of the scheduled scaling policy

Used by actions: DescribeTimerScalingPolicies, PutTimerScalingPolicy.

Name Type Required Description
Day Integer No Execute once every X day(s)
Note: this field may return null, indicating that no valid values can be obtained.
FromDay Integer No Specify the first day to execute the scaling action in a month (execute once per day)
Note: this field may return null, indicating that no valid values can be obtained.
ToDay Integer No Specify the last day to execute the scaling action in a month
Note: this field may return null, indicating that no valid values can be obtained.
WeekDays Array of Integer No Specify the week days to repeat the scaling action. Multiple values are supported. Valid values: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday).
Note: this field may return null, indicating that no valid values can be obtained.