建立 Insights 排程調整工作

Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule

Error codes

This operation may return the following PlayFab errors:

Error	Code
InvalidScheduledTaskName	1256
InvalidTaskSchedule	1257
ProductDisabledForTitle	1609
ScheduledTaskCreateConflict	1255
ScheduledTaskNameConflict	1254
TitleNotOnUpdatedPricingPlan	9000

POST

Admin

CreateInsightsScheduledScalingTask

Create Insights Scheduled Scaling Task

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Name": "EnableWeekdayPerformance",
  "Description": "Scale up Insights Performance Units during weekdays.",
  "Schedule": "0 0 * * 1-5",
  "Parameter": {
    "Level": 3
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask"

payload = {
    "Name": "EnableWeekdayPerformance",
    "Description": "Scale up Insights Performance Units during weekdays.",
    "Schedule": "0 0 * * 1-5",
    "Parameter": { "Level": 3 }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'EnableWeekdayPerformance',
    Description: 'Scale up Insights Performance Units during weekdays.',
    Schedule: '0 0 * * 1-5',
    Parameter: {Level: 3}
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'EnableWeekdayPerformance',
    'Description' => 'Scale up Insights Performance Units during weekdays.',
    'Schedule' => '0 0 * * 1-5',
    'Parameter' => [
        'Level' => 3
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask"

	payload := strings.NewReader("{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "TaskId": "644FA3A39C9714BC"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

授權

X-SecretKey

string

header

必填

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

主體

application/json

Task name is unique within a title. Using a task name that's already taken will cause a name conflict error. Too many create-task requests within a short time will cause a create conflict error.

IsActive

boolean

必填

Whether the schedule is active. Inactive schedule will not trigger task execution.

Name

string

必填

Name of the task. This is a unique identifier for tasks in the title.

Parameter

object

必填

Task details related to Insights Scaling

Show child attributes

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Description

string

Description the task

Schedule

string

Cron expression for the run schedule of the task. The expression should be in UTC.

回應

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

範例:

{ "TaskId": "644FA3A39C9714BC" }

最後修改於 2026年10月6日

相關主題

排程調整 Insights Insights 最佳做法排程待命排程工作快速入門

⌘I

Create Insights Scheduled Scaling Task

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Name": "EnableWeekdayPerformance",
  "Description": "Scale up Insights Performance Units during weekdays.",
  "Schedule": "0 0 * * 1-5",
  "Parameter": {
    "Level": 3
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask"

payload = {
    "Name": "EnableWeekdayPerformance",
    "Description": "Scale up Insights Performance Units during weekdays.",
    "Schedule": "0 0 * * 1-5",
    "Parameter": { "Level": 3 }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Name: 'EnableWeekdayPerformance',
    Description: 'Scale up Insights Performance Units during weekdays.',
    Schedule: '0 0 * * 1-5',
    Parameter: {Level: 3}
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'EnableWeekdayPerformance',
    'Description' => 'Scale up Insights Performance Units during weekdays.',
    'Schedule' => '0 0 * * 1-5',
    'Parameter' => [
        'Level' => 3
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask"

	payload := strings.NewReader("{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Name\": \"EnableWeekdayPerformance\",\n  \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n  \"Schedule\": \"0 0 * * 1-5\",\n  \"Parameter\": {\n    \"Level\": 3\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "TaskId": "644FA3A39C9714BC"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

建立 Insights 排程調整工作

Error codes

授權

主體

回應