Calls Listing (ssd api-management list traces)

The ssd api-management list traces command allows you to list calls for managed APIs on Sensedia API Platform.

You can use the ssd api-management list traces command or its shortened version ssd apim list traces.

For more specific information, refer to the documentation about General Trace on Sensedia API Platform.

Usage

The ssd api-management list traces command can be followed by flags with their respective arguments:

ssd api-management list traces [flags]

If no flag is specified, the interactive mode will be enabled.

# Lists the latest calls for an APIs.
$ ssd api-management list traces --api-name “My API” --api-version 1.0 --revision 1 --method GET --resource resource

# Lists the latest calls for an API in an environment
$ ssd api-management list traces --api-name “My API” --api-version 1.0 --revision 1 --method GET --resource resource --environment Production

# Lists the latest calls for an API by HTTP Response
$ ssd api-management list traces --api-name “My API” --api-version 1.0 --revision 1 --method GET --resource resource --http-response “ERROR”

# Lists the latest calls for an API by selecting a trace limit
$ ssd api-management list traces --api-name “My API” --api-version 1.0 --revision 1 --method GET --resource resource --limit 100

Available flags

The following flags can be used with the ssd api-management list traces command:

Flag

Type

Description

-n , --api-name

string

Name of the monitored API

-v , --api-version

string

Version of the monitored API

-e , --environments

string

A specific API environment to filter by

-h, --help

Displays help for the command

--http-response

string

HTTP response status. Available options: "SUCCESS", "ERROR", "CLIENT ERROR", "SERVER ERROR". Default: ALL

--limit

int

Number of calls to be displayed. It must be an integer from 1 to 500. If this flag is not specified, the default will be 50 calls

-m , --method

string

HTTP method of the request

-o, --output

string

Specifies the display type of the information. E.g.: -o json

-p, --page

int

Specifies from which page to display the information. E.g.: --page 1

-q, --query

string

Filters the information to be returned. E.g.: --query apiName:Users

-r , --resource

string

Name of the resource used in the request (URI)

--revision

string

Revision of the monitored API

-s, --size

int

Number of resources to be listed. E.g.: --size 100

Global Flags

Flag

Type

Description

-c, --config

string

Configuration file (default: $HOME/.sensedia/config.json)

--profile

string

The configuration profile you want to use (default: "default")

--verbose

Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]