Objective-C / Core Services API / CaptureConsoleHistory
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "instanceId": "Excepteur",
// "definedTags": {},
// "displayName": "in est ex",
// "freeformTags": {}
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"instanceId" value: @"Excepteur"];
[json UpdateNewObject: @"definedTags"];
[json UpdateString: @"displayName" value: @"in est ex"];
[json UpdateNewObject: @"freeformTags"];
[http SetRequestHeader: @"opc-retry-token" value: @"aliqua enim i"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-content-sha256" value: @"{{content_sha256}}"];
[http SetRequestHeader: @"Authorization" value: @"{{signature}}"];
[http SetRequestHeader: @"Date" value: @"{{date}}"];
CkoHttpResponse *resp = [http PostJson3: @"https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleHistories/" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "mollit in ex cillum",
// "compartmentId": "in",
// "lifecycleState": "SUCCEEDED",
// "availabilityDomain": "consequat in enim",
// "timeCreated": "1965-06-11T15:32:56.754Z",
// "instanceId": "nulla occaecat minim",
// "definedTags": {},
// "displayName": "magna in eiusmod",
// "freeformTags": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *id = [jResp StringOf: @"id"];
NSString *compartmentId = [jResp StringOf: @"compartmentId"];
NSString *lifecycleState = [jResp StringOf: @"lifecycleState"];
NSString *availabilityDomain = [jResp StringOf: @"availabilityDomain"];
NSString *timeCreated = [jResp StringOf: @"timeCreated"];
NSString *instanceId = [jResp StringOf: @"instanceId"];
NSString *displayName = [jResp StringOf: @"displayName"];
Curl Command
curl -X POST
-H "opc-retry-token: aliqua enim i"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"instanceId": "Excepteur",
"definedTags": {},
"displayName": "in est ex",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleHistories/
Postman Collection Item JSON
{
"name": "CaptureConsoleHistory",
"request": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
},
{
"key": "x-content-sha256",
"value": "{{content_sha256}}",
"description": "(Required) Content sha256 for POST, PUT and PATCH operations",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
},
"description": "Captures the most recent serial console data (up to a megabyte) for the\nspecified instance.\n\nThe `CaptureConsoleHistory` operation works with the other console history operations\nas described below.\n\n1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the\nmost recent console history. This call returns a `ConsoleHistory`\nobject. The object will have a state of REQUESTED.\n2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with\nthe identifier of the console history metadata. The state of the\n`ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and\nthen SUCCEEDED (or FAILED).\n3. Use `GetConsoleHistoryContent` to get the actual console history data (not the\nmetadata).\n4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata\nand the console history data.\n"
},
"response": [
{
"name": "The console history is being captured.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "etag",
"value": "officia sed",
"description": "For optimistic concurrency control. See `if-match`.\n"
},
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"mollit in ex cillum\",\n \"compartmentId\": \"in\",\n \"lifecycleState\": \"SUCCEEDED\",\n \"availabilityDomain\": \"consequat in enim\",\n \"timeCreated\": \"1965-06-11T15:32:56.754Z\",\n \"instanceId\": \"nulla occaecat minim\",\n \"definedTags\": {},\n \"displayName\": \"magna in eiusmod\",\n \"freeformTags\": {}\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "An error has occurred.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"instanceId\": \"Excepteur\",\n \"definedTags\": {},\n \"displayName\": \"in est ex\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/instanceConsoleHistories/",
"host": [
"{{baseUrl}}"
],
"path": [
"instanceConsoleHistories",
""
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
}
]
}