cam · 2019-01-16

GetPolicy

POST

Query and view policy details.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cam/GetPolicy path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cam.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cam/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cam.api3.convergecloud.com' \
  -H 'X-TC-Action: GetPolicy' \
  -H 'X-TC-Version: 2019-01-16' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
PolicyId	integer	Yes	Policy ID

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
PolicyName	string	Policy name
Description	string	Policy description
Type	integer	1: Custom policy; 2: Preset policy
AddTime	string	Time created
UpdateTime	string	Time of latest update
PolicyDocument	string	Policy document
PresetAlias	string	Remarks
IsServiceLinkedRolePolicy	integer	Whether it is a service-linked policy
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "PolicyName": …,
    "Description": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cam.

SecretIdSecretKey

Request bodyvalid JSONPOST cam.api3.convergecloud.com · GetPolicy

{}

Read-only. Creates nothing.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound.PolicyIdNotFound",
      "Message": "policy id is not exist",
      "code": 11026,
      "msg": "policy id is not exist",
      "value": null
    },
    "RequestId": "b24e100b-cbd3-7d62-0c99-e723ff0dfcc9"
  }
}