Request IDs in IBM Storage Scale native REST API

Request IDs are used in the scalectl or the scaleadmd logs to track logs related to a particular client-initiated request.

Log lines from the scalectl command or scaleadmd contains an ID field, which is a unique identifier for each request. The value for this field is a uuidv4 string. The scalectl command generates an ID for each command invocation. The scaleadmd service uses this request ID along with the command arguments and flags during processing the request. If another scaleadmd service needs to process the same request, it uses the same request ID. You can use the request ID to track the lifecycle across all nodes by searching for it in the log files.

For a different REST client, such as curl instead of scalectl CLI, specify the request id with the header X-StorageScaleReqId for that particular request. The value must be a valid uuidv4 string. For example,

curl -X GET -n https://mynode:46443/scalemgmt/v3/nsds -H "X-StorageScaleReqId: 949ca61d-ace8-4963-9b9a-7d550613dc38"

Note: The -n option in the previous example requires the .netrc file in the home directory for the authentication. For more information, see Authentication for IBM Storage Scale native REST API.

If no request id is specified in the header, a new uuidv4 is automatically generated in the scaleadmd.