Akamai APIs API Documentation
Check a metadata tracing request status
GET https://{{host}}/edge-diagnostics/v1/metadata-tracer/requests/:requestId
Returns the status of the asynchronous Launch a Metadata Tracer request operation. For operations with the SUCCESS status, the response includes the metadata details. For requests with the Accept: text/html request header, results are in static HTML format. To learn more about the results, check How to read the results.
Body
PARAM
| Key | Datatype | Required | Description |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"completedTime": "2021-04-20T08:50:36Z",
"createdBy": "szhang",
"createdTime": "2021-04-20T08:50:34Z",
"edgeIpLocation": {
"asNumber": 123,
"city": "TOKYO",
"countryCode": "JP",
"regionCode": "13"
},
"executionStatus": "SUCCESS",
"internalIp": "192.0.2.12",
"request": {
"edgeIp": "192.0.2.12",
"requestHeaders": [
"Connection: keep-alive",
"Accept-Language: en-US"
],
"url": "https://www.example.com"
},
"requestId": 241,
"result": {
"arlDataXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<configs xmlns:cache=\"uri:akamai.com/metadata/cache/5.0\" xmlns:edgeservices=\"uri:akamai.com/metadata/edgeservices/5.0\" xmlns:config=\"uri:akamai.com/metadata/config/5.0\" xmlns:network=\"uri:akamai.com/metadata/network/5.0\" xmlns:auth=\"uri:akamai.com/metadata/auth/5.0\" xmlns:match=\"uri:akamai.com/metadata/match/5.0\" xmlns:forward=\"uri:akamai.com/metadata/forward/5.0\" xmlns:comment=\"uri:akamai.com/metadata/comment/5.0\" xmlns:akamai=\"uri:akamai.com/metadata/akamai/5.0\" xmlns:security=\"uri:akamai.com/metadata/security/5.0\" xmlns:reporting=\"uri:akamai.com/metadata/reporting/5.0\" xmlns:edgecomputing=\"uri:akamai.com/metadata/edgecomputing/5.0\" xmlns:assign=\"uri:akamai.com/metadata/assign/5.0\">\n\n <comment:note value=\"Property Manager generated metadata. XML engine version: 22.6\"/>\n <comment:note value=\"Catalog version: 22.6\"/>\n <comment:note value=\"Product name: Fresca\"/>\n <comment:note value=\"Property name: mdt.stmtesting.com, version: 15\"/>\n <comment:note value=\"Asset ID: 10976512\"/>\n <comment:note value=\"File ID: 763347\"/>\n <comment:note value=\"AcgID: \"/>\n <comment:note value=\"AccountId: B-C-1IE2OH8\"/>\n <comment:note value=\"Hostnames: mct.gshaw.in mdt.gshaw.in mdt.stmtesting.com\"/>\n <akamai:edge-config version=\"5.0\">\n <edgeservices:product.name>Fresca</edgeservices:product.name>\n <config:metadata.fma>\n <arl-version>15</arl-version>\n </config:metadata.fma>\n <assign:variable>\n <name>AKA_PM_FLAGS</name>\n <value>-</value>\n <hidden>on</hidden>\n </assign:variable>\n <assign:variable>\n <name>AKA_PM_PROPERTY_NAME</name>\n <value>mdt.stmtesting.com</value>\n </assign:variable>\n <assign:variable>\n <name>AKA_PM_PROPERTY_VERSION</name>\n <value>15</value>\n </assign:variable>\n <edgeservices:modify-outgoing-response.http-version>1.1</edgeservices:modify-outgoing-response.http-version>\n <edgeservices:modify-outgoing-request.accept-chunking>on</edgeservices:modify-outgoing-request.accept-chunking>\n <edgeservices:cookie.pass-set-cookie-policy>CONNECTION</edgeservices:cookie.pass-set-cookie-policy>\n <match:metadata-stage value=\"client-request content-policy\">\n ",
"httpStatusCode": 200,
"httpVersion": "HTTP/1.1",
"reasonPhrase": "OK",
"responseHeaderList": [
"X-Cache: HIT",
"Cache-Control: max-age=604800",
"Date: Tue, 20 Apr 2021 08:50:35 GMT",
"Content-Type: text/html; charset=UTF-8"
],
"traceInformation": [
{
"line": 15,
"stages": {
"failures": [],
"successes": [
"S0_CLIENT_REQUEST"
]
}
},
{
"line": 28,
"stages": {
"failures": [],
"successes": [
"S7_CLIENT_RESPONSE"
]
}
}
]
},
"summary": {
"accountId": "A-CCT3456",
"assetId": "456134",
"contractId": "C-0N7RAC71",
"groupId": "12345",
"propertyId": "763347",
"propertyName": "mdt.stmtesting.com",
"propertyVersion": 15,
"ruleFormat": "latest",
"rules": {
"options": {
"is_secure": false
},
"behaviors": [
{
"options": {
"cacheKeyHostname": "REQUEST_HOST_HEADER",
"compress": true,
"enableTrueClientIp": true,
"forwardHostHeader": "ORIGIN_HOSTNAME",
"httpPort": 80,
"httpsPort": 443
},
"executionStatus": "NOT_EXECUTED",
"lineRange": {
"end": 141,
"start": 140
},
"name": "origin"
},
{
"options": {
"enabled": true
},
"executionStatus": "NOT_EXECUTED",
"lineRange": {
"end": 105,
"start": 152
},
"name": "edgeScape"
}
],
"children": [
{
"behaviors": [
{
"options": {
"cacheKeyHostname": "ORIGIN_HOSTNAME",
"compress": true,
"originCertificate": "",
"originSni": false,
"ports": "",
"verificationMode": "PLATFORM_SETTINGS"
},
"executionStatus": "NOT_EXECUTED",
"lineRange": {
"end": 105,
"start": 102
},
"name": "origin"
},
{
"options": {
"value": {
"createdDate": 1580378379000,
"description": "t1info.stmtesting.com",
"id": 928922,
"name": "t1info.stmtesting.com",
"products": [
"Fresca"
]
}
},
"executionStatus": "NOT_EXECUTED",
"lineRange": {
"end": 125,
"start": 112
},
"name": "cpCode"
}
],
"children": [],
"criteria": [
{
"options": {
"checkIps": "BOTH",
"countryValues": [
"IL"
],
"field": "COUNTRY",
"matchOperator": "IS_ONE_OF",
"useOnlyFirstXForwardedForIp": false
},
"name": "userLocation"
}
],
"criteriaMustSatisfy": "any",
"name": "OR Rule"
},
{
"behaviors": [
{
"options": {
"httpPort": 80,
"httpsPort": 443,
"originCertificate": "",
"originSni": true,
"ports": "",
"trueClientIpClientSetting": false,
"trueClientIpHeader": "True-Client-IP",
"verificationMode": "PLATFORM_SETTINGS"
},
"executionStatus": "NOT_EXECUTED",
"lineRange": {
"end": 135,
"start": 130
},
"name": "origin"
}
],
"children": [],
"criteria": [
{
"options": {
"matchCaseSensitive": false,
"matchOperator": "MATCHES_ONE_OF",
"normalize": false,
"values": [
"/echo"
]
},
"name": "path"
},
{
"options": {
"matchOperator": "IS_ONE_OF",
"values": [
"mdt.stmtesting.com"
]
},
"name": "hostname"
}
],
"criteriaMustSatisfy": "all",
"name": "AND Rule"
}
],
"comments": "The Default Rule template contains all the necessary and recommended behaviors. Rules are evaluated from top to bottom and the last matching rule wins.",
"name": "default",
"uuid": "default",
"variables": [
{
"description": "",
"hidden": false,
"name": "PMUSER_TEST_VAR",
"sensitive": false,
"value": ""
}
]
}
}
} |
Curl
curl -X GET 'https://undefined/edge-diagnostics/v1/metadata-tracer/requests/:requestId?accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS