Chilkat Online Tools

DescribeWorkspace TCL Example

AWS Managed Grafana

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "grafana"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://grafana.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "grafana.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "DescribeWorkspace"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/workspaces/{workspaceId}" $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set AccountAccessType [CkJsonObject_stringOf $jResp "workspace.accountAccessType"]
set SamlConfigurationStatus [CkJsonObject_stringOf $jResp "workspace.authentication.samlConfigurationStatus"]
set Created [CkJsonObject_IntOf $jResp "workspace.created"]
set Description [CkJsonObject_stringOf $jResp "workspace.description"]
set Endpoint [CkJsonObject_stringOf $jResp "workspace.endpoint"]
set FreeTrialConsumed [CkJsonObject_IntOf $jResp "workspace.freeTrialConsumed"]
set FreeTrialExpiration [CkJsonObject_IntOf $jResp "workspace.freeTrialExpiration"]
set GrafanaVersion [CkJsonObject_stringOf $jResp "workspace.grafanaVersion"]
set Id [CkJsonObject_stringOf $jResp "workspace.id"]
set LicenseExpiration [CkJsonObject_IntOf $jResp "workspace.licenseExpiration"]
set LicenseType [CkJsonObject_stringOf $jResp "workspace.licenseType"]
set Modified [CkJsonObject_IntOf $jResp "workspace.modified"]
set Name [CkJsonObject_stringOf $jResp "workspace.name"]
set OrganizationRoleName [CkJsonObject_stringOf $jResp "workspace.organizationRoleName"]
set PermissionType [CkJsonObject_stringOf $jResp "workspace.permissionType"]
set StackSetName [CkJsonObject_stringOf $jResp "workspace.stackSetName"]
set Status [CkJsonObject_stringOf $jResp "workspace.status"]
set v_String [CkJsonObject_stringOf $jResp "workspace.tags.string"]
set WorkspaceRoleArn [CkJsonObject_stringOf $jResp "workspace.workspaceRoleArn"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "workspace.authentication.providers"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "workspace.authentication.providers[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "workspace.dataSources"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "workspace.dataSources[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "workspace.notificationDestinations"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "workspace.notificationDestinations[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "workspace.organizationalUnits"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "workspace.organizationalUnits[i]"]
    set i [expr $i + 1]
}

# A sample JSON response body parsed by the above code:

# {
#   "workspace": {
#     "accountAccessType": "string",
#     "authentication": {
#       "providers": [
#         "string"
#       ],
#       "samlConfigurationStatus": "string"
#     },
#     "created": number,
#     "dataSources": [
#       "string"
#     ],
#     "description": "string",
#     "endpoint": "string",
#     "freeTrialConsumed": boolean,
#     "freeTrialExpiration": number,
#     "grafanaVersion": "string",
#     "id": "string",
#     "licenseExpiration": number,
#     "licenseType": "string",
#     "modified": number,
#     "name": "string",
#     "notificationDestinations": [
#       "string"
#     ],
#     "organizationalUnits": [
#       "string"
#     ],
#     "organizationRoleName": "string",
#     "permissionType": "string",
#     "stackSetName": "string",
#     "status": "string",
#     "tags": {
#       "string": "string"
#     },
#     "workspaceRoleArn": "string"
#   }
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp