CopyFleet

Last updated: 2021-05-20 16:37:07

    1. API Description

    Domain name for API request: gse.tencentcloudapi.com.

    This API is used to replicate server fleet.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CopyFleet.
    Version Yes String Common parameter. The value used for this API: 2019-11-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    FleetId Yes String Server fleet ID
    CopyNumber Yes Integer Replica number. It should a value between 1 to the number of the remaining quota. It can be obtained through Obtaining User Quota.
    AssetId No String Asset package ID
    Description No String Description. The length is 0-100 characters.
    InboundPermissions.N No Array of InboundPermission Network configuration
    InstanceType No String Server type. It can be obtained through Obtaining Server Instance Type List.
    FleetType No String Server fleet type, which only supports “ON_DEMAND” type now.
    Name No String Server fleet name. The length is 1-50 characters.
    NewGameServerSessionProtectionPolicy No String Protection policy. Valid values: NoProtection·(no protection), FullProtection (full protection), TimeLimitProtection (time-limited protection)
    ResourceCreationLimitPolicy No ResourceCreationLimitPolicy Limit policy of resource creation
    RuntimeConfiguration No RuntimeConfiguration Progress configuration
    GameServerSessionProtectionTimeLimit No Integer Timeout period of time-limited protection. Value range: 5-1440 minutes. Default value: 60 minutes. This parameter is valid only when NewGameSessionProtectionPolicy is set as TimeLimitProtection.
    SelectedScalingType No String Whether to select scaling. Valid values: SCALING_SELECTED, SCALING_UNSELECTED. Default value: SCALING_UNSELECTED.
    SelectedCcnType No String Whether to associate the fleet with a CCN instance: CCN_SELECTED_BEFORE_CREATE (associate before creation), CCN_SELECTED_AFTER_CREATE (associated after creation), or CCN_UNSELECTED (do not associate); CCN_UNSELECTED by default
    Tags.N No Array of Tag Tag list. Up to 50 tags.
    SystemDiskInfo No 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.
    DataDiskInfo.N No 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.
    SelectedTimerType No String Whether to select to replicate the timer policy: TIMER_SELECTED or TIMER_UNSELECTED. The default value is TIMER_UNSELECTED.
    CcnInfos.N No Array of CcnInfo Information of the CCN instance, including the owner account and the instance ID.
    InternetMaxBandwidthOut No Integer Maximum outbound public network bandwidth of the server fleet. Value range: 1 - 200 Mbps. Default value: 100 Mbps.

    3. Output Parameters

    Parameter Name Type Description
    FleetAttributes Array of FleetAttributes Server fleet attributes
    Note: this field may return null, indicating that no valid value is obtained.
    TotalCount Integer The number of server fleets
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Replicating server fleet

    Input Example

    https://gse.tencentcloudapi.com/?Action=CopyFleet
    &FleetId=fleet-qp3g3caa-2m6pzf4g
    &AssetId=asset-qrdiw1a9
    &Description=Human description
    &InstanceType=S5.LARGE8
    &FleetType=ON_DEMAND
    &Name=testfleet
    &NewGameServerSessionProtectionPolicy=TimeLimitProtection
    &ResourceCreationLimitPolicy.NewGameServerSessionsPerCreator=2
    &ResourceCreationLimitPolicy.PolicyPeriodInMinutes=0
    &RuntimeConfiguration.GameServerSessionActivationTimeoutSeconds=5
    &RuntimeConfiguration.MaxConcurrentGameServerSessionActivations=5
    &RuntimeConfiguration.ServerProcesses.0.ConcurrentExecutions=10
    &RuntimeConfiguration.ServerProcesses.0.LaunchPath=/local/game/GameLiftLinuxServer
    &InboundPermissions.0.FromPort=1900
    &InboundPermissions.0.IpRange=0.0.0.0/0
    &InboundPermissions.0.Protocol=TCP
    &InboundPermissions.0.ToPort=2900
    &SelectedScalingType=SCALING_UNSELECTED
    &SelectedCcnType=CCN_UNSELECTED
    &SelectedTimerType=TIMER_UNSELECTED
    &CopyNumber=1
    &DataDiskInfo.0.DiskType=CLOUD_PREMIUM
    &DataDiskInfo.0.DiskSize=50
    &SystemDiskInfo.DiskType=CLOUD_PREMIUM
    &SystemDiskInfo.DiskSize=50
    &<Common request parameters>

    Output Example

    {
    "Response": {
      "FleetAttributes": [
        {
          "AssetId": "asset-qrdiw1a9",
          "BillingStatus": "BILLING_ACTIVATED",
          "CreationTime": "2020-11-18T04:01:03Z",
          "Description": "Human description test update",
          "FleetArn": "qcs::gse:ap-shanghai:uin/838831829:fleet/fleet-qp3g3caa-95z2gimq",
          "FleetId": "fleet-qp3g3caa-95z2gimq",
          "FleetType": "ON_DEMAND",
          "GameServerSessionProtectionTimeLimit": 60,
          "InstanceType": "S5.LARGE8",
          "Name": "frederickli-test-fleet",
          "NewGameServerSessionProtectionPolicy": "TimeLimitProtection",
          "OperatingSystem": "CentOS 7.16 64-bit",
          "ResourceCreationLimitPolicy": {
            "NewGameServerSessionsPerCreator": 2,
            "PolicyPeriodInMinutes": 3
          },
          "Status": "NEW",
          "StoppedActions": [],
          "TerminationTime": null,
          "DataDiskInfo": [
            {
              "DiskType": "CLOUD_PREMIUM",
              "DiskSize": 50
            }
          ],
          "SystemDiskInfo": {
            "DiskType": "CLOUD_PREMIUM",
            "DiskSize": 50
          }
        }
      ],
      "RequestId": "s1605672063311364390",
      "TotalCount": 1
    }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error
    AuthFailure.UnauthorizedOperation The resource is unauthorized.
    FailedOperation Operation failed.
    InternalError An internal error occurred.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded The quota limit is exceeded.
    LimitExceeded.FleetLimitExceeded The number of server fleets exceeds the upper limit.
    LimitExceeded.InstanceLimitExceeded The number of servers exceeds the upper limit.
    MissingParameter Missing parameter.
    OperationDenied Operation denied
    RequestLimitExceeded Request exceeds the frequency limit.
    ResourceInUse The resource is in use.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.ServiceNotOpened The service is not activated.
    UnsupportedOperation Unsupported operation.