cfw · 2019-09-04

DescribeSourceAsset

POST

Get all asset information of an asset group.

Wire call

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

Request parameters

Field	Type	Required	Description
FuzzySearch	string	—	Fuzzy search
InsType	string	—	Asset type. 1: public network; 2: private network
ChooseType	string	—	If ChooseType is 1, grouped assets are queried; if ChooseType is not 1, non-grouped assets are queried
Zone	string	—	Region
Limit	integer	—	Maximum number of results returned per page. For example, if it is set to 10, 10 results will be returned at most.
Offset	integer	—	Offset of search results

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
ZoneList	AssetZone[]	Region collection
Data	InstanceInfo[]	Data
Total	integer	Total number of returned data
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "ZoneList": …,
    "Data": …,
    "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/cfw.

SecretIdSecretKey

Request bodyvalid JSONPOST cfw.api3.convergecloud.com · DescribeSourceAsset

{}

Read-only. Creates nothing.

Recorded example response

{
  "Data": [],
  "RequestId": "cc5c9c4d-05b6-4378-3859-07000ab74fa7",
  "Total": 0,
  "ZoneList": []
}