cam · 2019-01-16

DescribeRoleList

POST

Get the role list under the account.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cam/DescribeRoleList 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: DescribeRoleList' \
  -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
Page	integer	Yes	Page number, beginning from 1
Rp	integer	Yes	Number of lines per page, no greater than 200
Tags	RoleTags[]	No	A parameter used to filter the list of roles under a tag.

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
List	RoleInfo[]	Role details list
TotalNum	integer	Total number of roles
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "List": …,
    "TotalNum": …,
    "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 · DescribeRoleList

{}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "List": [
      {
        "AddTime": "2026-09-13 19:02:35",
        "ConsoleLogin": 1,
        "Description": "该策略仅供集团账号管理（Organization）服务相关角色（Orgnization_QCSLinkedRoleInServiceControl）进行关联，用于Organization访问其他云服务资源。",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":[\"qcs::cam::uin/91000000001:root\"]}}]}",
        "RoleId": "4611686018427388296",
        "RoleName": "Organization_QCSLinkedRoleInDefaultMng",
        "RoleType": "organization",
        "SessionDuration": 0,
        "UpdateTime": "2026-09-13 19:02:35"
      },
      {
        "AddTime": "2026-09-15 16:39:30",
        "ConsoleLogin": 1,
        "Description": "Organization AccessController Role",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":\"qcs::cam::uin/100000000001:uin/100000000001\"}}]}",
        "RoleId": "4611686018427388297",
        "RoleName": "OrganizationAccessControlRole",
        "RoleType": "organization",
        "SessionDuration": 0,
        "UpdateTime": "2026-09-15 16:39:30"
      },
      {
        "AddTime": "2026-09-13 19:02:35",
        "ConsoleLogin": 1,
        "Description": "该策略仅供集团账号管理（Organization）服务相关角色（Orgnization_QCSLinkedRoleInServiceControl）进行关联，用于Organization访问其他云服务资源。",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":[\"qcs::cam::uin/91000000001:root\"]}}]}",
        "RoleId": "4611686018427388299",
        "RoleName": "Orgnization_QCSLinkedRoleInServiceControl",
        "RoleType": "organization",
        "SessionDuration": 0,
        "UpdateTime": "2026-09-13 19:02:35"
      },
      {
        "AddTime": "2026-09-15 16:39:30",
        "ConsoleLogin": 1,
        "Description": "Organization AccessController Role",
        "PolicyDocument": "{\"version\":\"2.0\",\"statement\":[{\"action\":\"name/sts:AssumeRole\",\"effect\":\"allow\",\"principal\":{\"qcs\":\"qcs::cam::uin/100000000001:uin/100000000001\"}}]}",
        "RoleId": "4611686018427388323",
        "RoleName": "OrganizationAccessReadOnlyMngRole",
        "RoleType": "organization",
        "SessionDuration": 0,
        "UpdateTime": "2026-09-15 16:39:30"
      }
    ],
    "RequestId": "aad5f70a-ddbf-e8e0-9c1c-fc41b7dc6de8",
    "TotalNum": 4
  }
}