vpc · 2017-03-12

DescribeSecurityGroupAssociationStatistics

POST

Query statistics on the instances associated with a security group.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeSecurityGroupAssociationStatistics 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://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeSecurityGroupAssociationStatistics' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"SecurityGroupIds":["<SecurityGroupId>"]}'

Request parameters

Field	Type	Required	Description
SecurityGroupIds	string[]	Yes	The Security instance ID, such as `sg-33ocnj9n`. It can be obtained through DescribeSecurityGroups.

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
SecurityGroupAssociationStatisticsSet	SecurityGroupAssociationStatistics[]	Statistics on the instances associated with a security group.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "SecurityGroupAssociationStatisticsSet": …,
    "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/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeSecurityGroupAssociationStatistics

{
  "SecurityGroupIds": [
    "<SecurityGroupId>"
  ]
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "SecurityGroupAssociationStatisticsSet": [
      {
        "SecurityGroupId": "sg-4e74nn5y",
        "CDB": 0,
        "CVM": 0,
        "ENI": 0,
        "SG": 0,
        "CLB": 0,
        "InstanceStatistics": [
          {
            "InstanceType": "CDB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CVM",
            "InstanceCount": 0
          },
          {
            "InstanceType": "ENI",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CLB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "DCDB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "HSM",
            "InstanceCount": 0
          },
          {
            "InstanceType": "MongoDB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "Mariadb",
            "InstanceCount": 0
          },
          {
            "InstanceType": "Redis",
            "InstanceCount": 0
          },
          {
            "InstanceType": "TBASE",
            "InstanceCount": 0
          },
          {
            "InstanceType": "SQLSERVER",
            "InstanceCount": 0
          },
          {
            "InstanceType": "HAI",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CHC",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CUBEGW",
            "InstanceCount": 0
          },
          {
            "InstanceType": "VDB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CYNOSDBMYSQL",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CTSDBI",
            "InstanceCount": 0
          },
          {
            "InstanceType": "POSTGRES",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CYNOSDBPG",
            "InstanceCount": 0
          },
          {
            "InstanceType": "TDAPG",
            "InstanceCount": 0
          },
          {
            "InstanceType": "ELASTICSEARCH",
            "InstanceCount": 0
          },
          {
            "InstanceType": "NATGW",
            "InstanceCount": 0
          },
          {
            "InstanceType": "ENDPOINT",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CASB",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CVP",
            "InstanceCount": 0
          },
          {
            "InstanceType": "KONISGRAPH",
            "InstanceCount": 0
          },
          {
            "InstanceType": "TDSTORE",
            "InstanceCount": 0
          },
          {
            "InstanceType": "LB-WAN",
            "InstanceCount": 0
          },
          {
            "InstanceType": "CVD",
            "InstanceCount": 0
          },
          {
            "InstanceType": "EKS",
            "InstanceCount": 0
          },
          {
            "InstanceType": "LB-LAN",
            "InstanceCount": 0
          }
        ],
        "TotalCount": 0
      }
    ],
    "RequestId": "ba1f9b51-87c9-6809-0f15-7890a6e61eb8"
  }
}

Behaviour

Accepts up to 100 ids and rejects 101 with InvalidParameterValue.LimitExceeded. An unknown id fails the whole request with ResourceNotFound rather than being omitted. The InstanceStatistics breakdown overlaps the top-level counters, so the two should not be summed.