Data Types

Last updated: 2020-07-03 09:29:04

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
Value String Attribute value

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
Note: this field may return null, indicating that no valid values can be obtained.
CurrentPlayerSessionCount Integer Current number of players
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
Note: this field may return null, indicating that no valid values can be obtained.
GameServerSessionData String Game server session attribute details
Note: this field may return null, indicating that no valid values can be obtained.
GameServerSessionId String Game server session ID
IpAddress String CVM IP address
MatchmakerData String Battle progress details
Note: this field may return null, indicating that no valid values can be obtained.
MaximumPlayerSessionCount Integer Maximum number of players
Name String Game server session name
Note: this field may return null, indicating that no valid values can be obtained.
PlayerSessionCreationPolicy String Player session creation policy
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Port number
Status String Game server session status
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
Note: this field may return null, indicating that no valid values can be 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
Note: this field may return null, indicating that no valid values can be 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 Maximum number of players
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

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.

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
IpAddress String Address of the CVM instance where the game server session is running
PlayerData String Player information
Note: this field may return null, indicating that no valid values can be obtained.
PlayerId String Player ID
Note: this field may return null, indicating that no valid values can be obtained.
PlayerSessionId String Player session ID
Port Integer Port number
Status String Player session status
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