Chilkat Online Tools

DescribeWorkspace Ruby Example

AWS Managed Grafana

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("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.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("grafana")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://grafana.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("grafana.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeWorkspace")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/workspaces/{workspaceId}",sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(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

AccountAccessType = jResp.stringOf("workspace.accountAccessType")
SamlConfigurationStatus = jResp.stringOf("workspace.authentication.samlConfigurationStatus")
Created = jResp.IntOf("workspace.created")
Description = jResp.stringOf("workspace.description")
Endpoint = jResp.stringOf("workspace.endpoint")
FreeTrialConsumed = jResp.IntOf("workspace.freeTrialConsumed")
FreeTrialExpiration = jResp.IntOf("workspace.freeTrialExpiration")
GrafanaVersion = jResp.stringOf("workspace.grafanaVersion")
Id = jResp.stringOf("workspace.id")
LicenseExpiration = jResp.IntOf("workspace.licenseExpiration")
LicenseType = jResp.stringOf("workspace.licenseType")
Modified = jResp.IntOf("workspace.modified")
Name = jResp.stringOf("workspace.name")
OrganizationRoleName = jResp.stringOf("workspace.organizationRoleName")
PermissionType = jResp.stringOf("workspace.permissionType")
StackSetName = jResp.stringOf("workspace.stackSetName")
Status = jResp.stringOf("workspace.status")
v_String = jResp.stringOf("workspace.tags.string")
WorkspaceRoleArn = jResp.stringOf("workspace.workspaceRoleArn")
i = 0
count_i = jResp.SizeOfArray("workspace.authentication.providers")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("workspace.authentication.providers[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.dataSources")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("workspace.dataSources[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.notificationDestinations")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("workspace.notificationDestinations[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.organizationalUnits")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("workspace.organizationalUnits[i]")
    i = i + 1
end

# 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"
#   }
# }