Data Types

Last updated: 2020-12-24 11:02:27

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

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.

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

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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help