Get Cloud Script Task Instance
Get detail information about a CloudScript task instance.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ProductDisabledForTitle | 1609 |
| TaskInstanceNotFound | 1262 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"TaskInstanceId": "E52531B47B1761C7-4"
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance"
payload = { "TaskInstanceId": "E52531B47B1761C7-4" }
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({TaskInstanceId: 'E52531B47B1761C7-4'})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance', 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/GetCloudScriptTaskInstance",
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([
'TaskInstanceId' => 'E52531B47B1761C7-4'
]),
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/GetCloudScriptTaskInstance"
payload := strings.NewReader("{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\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/GetCloudScriptTaskInstance")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance")
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 \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Summary": {
"TaskInstanceId": "B67ACA247F49EF47-8",
"TaskIdentifier": {
"Name": "EnableDailyHappyHour",
"Id": "B67ACA247F49EF47"
},
"StartedAt": "2016-08-23T12:33:14",
"CompletedAt": "2016-08-23T12:33:19",
"Result": {
"Revision": 3,
"FunctionResult": {
"newScore": 25
},
"Logs": [
{
"Level": "Info",
"Message": "Something normal happened",
"Data": {
"secondsAfterStart": 75
}
},
{
"Level": "Error",
"Message": "Something unexpected happened"
}
],
"ExecutionTimeSeconds": 0.03670790046453476,
"MemoryConsumedBytes": 38904,
"APIRequestsIssued": 2
}
},
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"presetName": "dailyHappyHour"
}
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
The result includes detail information that's specific to a CloudScript task. Only CloudScript tasks configured as "Run Cloud Script function once" will be retrieved. To get a list of task instances by task, status, or time range, use GetTaskInstances.
The result includes detail information that's specific to a CloudScript task. Only CloudScript tasks configured as "Run Cloud Script function once" will be retrieved. To get a list of task instances by task, status, or time range, use GetTaskInstances.
ID of the requested task instance.
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
{ "Summary": { "TaskInstanceId": "B67ACA247F49EF47-8", "TaskIdentifier": { "Name": "EnableDailyHappyHour", "Id": "B67ACA247F49EF47" }, "StartedAt": "2016-08-23T12:33:14", "CompletedAt": "2016-08-23T12:33:19", "Result": { "Revision": 3, "FunctionResult": { "newScore": 25 }, "Logs": [ { "Level": "Info", "Message": "Something normal happened", "Data": { "secondsAfterStart": 75 } }, { "Level": "Error", "Message": "Something unexpected happened" } ], "ExecutionTimeSeconds": 0.03670790046453476, "MemoryConsumedBytes": 38904, "APIRequestsIssued": 2 } }, "Parameter": { "FunctionName": "applyStorePreset", "Argument": { "presetName": "dailyHappyHour" } } }
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"TaskInstanceId": "E52531B47B1761C7-4"
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance"
payload = { "TaskInstanceId": "E52531B47B1761C7-4" }
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({TaskInstanceId: 'E52531B47B1761C7-4'})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance', 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/GetCloudScriptTaskInstance",
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([
'TaskInstanceId' => 'E52531B47B1761C7-4'
]),
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/GetCloudScriptTaskInstance"
payload := strings.NewReader("{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\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/GetCloudScriptTaskInstance")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetCloudScriptTaskInstance")
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 \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Summary": {
"TaskInstanceId": "B67ACA247F49EF47-8",
"TaskIdentifier": {
"Name": "EnableDailyHappyHour",
"Id": "B67ACA247F49EF47"
},
"StartedAt": "2016-08-23T12:33:14",
"CompletedAt": "2016-08-23T12:33:19",
"Result": {
"Revision": 3,
"FunctionResult": {
"newScore": 25
},
"Logs": [
{
"Level": "Info",
"Message": "Something normal happened",
"Data": {
"secondsAfterStart": 75
}
},
{
"Level": "Error",
"Message": "Something unexpected happened"
}
],
"ExecutionTimeSeconds": 0.03670790046453476,
"MemoryConsumedBytes": 38904,
"APIRequestsIssued": 2
}
},
"Parameter": {
"FunctionName": "applyStorePreset",
"Argument": {
"presetName": "dailyHappyHour"
}
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}