All Products
Search
Document Center

Performance Testing:GetPtsSceneRunningStatus

Last Updated:Nov 04, 2024

Queries the runtime status of a Performance Testing Service (PTS) scenario.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
pts:GetPtsSceneRunningStatus
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SceneIdstringYes

The ID of the scenario.

NHBG6V

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The system status code. If the operation is successful, this parameter is not returned

4001
CreateTimestring

The time when the scenario was created.

2021-03-01 16:05:56
HttpStatusCodeinteger

The request status code. If the operation is successful, this parameter is not returned

400
Messagestring

The error message. If the operation is successful, this parameter is not returned.

ModifiedTimestring

The last modification time of the scenario.

2021-03-26 16:03:56
RequestIdstring

The ID of the request.

DC4E3177-6745-4925-B423-4E89VV34221A
SceneNamestring

The name of the scenario.

Statusstring

The status of the scenario. Valid values:

  • CREATED
  • SYNCING
  • SYNC_DONE
  • UPLOADING
  • UPLOADED
  • PREPARING
  • READY
  • RUNNING
  • STOPPING
  • STOPPED
RUNNING
Successboolean

Indicates whether the operation is successful. Valid values:

  • true
  • false
false

Examples

Sample success responses

JSONformat

{
  "Code": "4001",
  "CreateTime": "2021-03-01 16:05:56",
  "HttpStatusCode": 400,
  "Message": "",
  "ModifiedTime": "2021-03-26 16:03:56",
  "RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
  "SceneName": "",
  "Status": "RUNNING",
  "Success": false
}

Error codes

HTTP status codeError codeError message
403GetPtsSceneRunningStatusFailThe scene does not exist

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history