'1.0', 'info' => ['style' => 'RPC', 'product' => 'PTS', 'version' => '2020-10-20'], 'directories' => [ [ 'children' => [ [ 'children' => ['CreatePtsSceneBaseLineFromReport', 'DeletePtsSceneBaseLine', 'UpdatePtsSceneBaseLine', 'GetPtsSceneBaseLine'], 'type' => 'directory', 'title' => 'Stress testing baseline', ], [ 'children' => ['ListPtsReports', 'GetPtsReportDetails', 'GetPtsReportsBySceneId', 'GetPtsDebugSampleLogs'], 'type' => 'directory', 'title' => 'Stress testing report', ], [ 'children' => ['StartDebugPtsScene', 'StartPtsScene', 'StopDebugPtsScene', 'StopPtsScene', 'GetPtsSceneRunningData', 'GetPtsSceneRunningStatus', 'AdjustPtsSceneSpeed'], 'type' => 'directory', 'title' => 'Stress testing execution', ], [ 'children' => ['CreatePtsScene', 'SavePtsScene', 'DeletePtsScene', 'DeletePtsScenes', 'ModifyPtsScene', 'GetPtsScene', 'ListPtsScene'], 'type' => 'directory', 'title' => 'Stress testing scenario', ], ], 'type' => 'directory', 'title' => 'PTS stress testing', ], [ 'children' => [ [ 'children' => ['GetJMeterReportDetails', 'GetJMeterLogs', 'GetJMeterSampleMetrics', 'GetJMeterSamplingLogs', 'ListJMeterReports'], 'type' => 'directory', 'title' => 'Stress testing report', ], [ 'children' => ['StartDebuggingJMeterScene', 'StartTestingJMeterScene', 'StopDebuggingJMeterScene', 'StopTestingJMeterScene', 'GetJMeterSceneRunningData', 'AdjustJMeterSceneSpeed'], 'type' => 'directory', 'title' => 'Stress testing execution', ], [ 'children' => ['RemoveOpenJMeterScene', 'SaveOpenJMeterScene', 'GetOpenJMeterScene', 'ListOpenJMeterScenes'], 'type' => 'directory', 'title' => 'Stress testing scenario', ], [ 'children' => ['RemoveEnv', 'SaveEnv', 'ListEnvs'], 'type' => 'directory', 'title' => 'Stress testing environment', ], ], 'type' => 'directory', 'title' => 'JMeter stress testing', ], [ 'children' => ['GetAllRegions', 'GetUserVpcs', 'GetUserVpcSecurityGroup', 'GetUserVpcVSwitch'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AdjustJMeterSceneSpeed' => [ 'summary' => 'Adjusting the JMeter load size.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The report ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The target load value.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DC4E31DDA77-6745-4925-B423-4E89VV34221A'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ReportId' => ['title' => '', 'description' => 'The report ID.', 'type' => 'string', 'example' => 'DYYPZIH'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'AdjustJMeterSceneSpeed', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustJMeterSceneSpeed'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:AdjustJMeterSceneSpeed', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"DC4E31DDA77-6745-4925-B423-4E89VV34221A\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true,\\n \\"ReportId\\": \\"DYYPZIH\\"\\n}","type":"json"}]', ], 'AdjustPtsSceneSpeed' => [ 'summary' => 'Adjusts the load of a PTS scenario.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], [ 'name' => 'ApiSpeedList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The speed adjustment configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiId' => ['description' => 'The API ID. Use this ID to find the corresponding API information in the relation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'DYXXX12H'], 'Speed' => ['description' => 'The target stress value. In concurrent mode, this is the concurrent value. In RPS mode, this is the RPS value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '30'], ], 'required' => false, 'description' => '', 'title' => '', ], 'required' => false, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4F7D2CE0-XXXX-4143-955A-8E4595AF86A6'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'AdjustPtsSceneSpeed', 'description' => 'In concurrent mode, pass the concurrent value for the first API in each trace. This value will be used for the entire trace.'."\n" ."\n" .'In Requests Per Second (RPS) mode, you can adjust the RPS value for each API. Within the same trace, ensure that the RPS values decrease for each subsequent API.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustPtsSceneSpeed'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:AdjustPtsSceneSpeed', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-XXXX-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CreatePtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '22649', 'abilityTreeNodes' => ['FEATUREptsFQKRPS'], ], 'parameters' => [ [ 'name' => 'Scene', 'in' => 'query', 'schema' => ['description' => 'The information about the scenario.', 'type' => 'string', 'example' => '{"loadConfig":{"agentCount":1,"apiLoadConfigList":[{"rpsBegin":10,"rpsLimit":100}],"configuration":{"allRpsBegin":10,"allRpsLimit":100},"maxRunningTime":1,"testMode":"tps_mode"},"relationList":[{"apiList":[{"apiName":"API 1 of chain 1","body":{"bodyValue":"{\\"key1\\":\\"111\\",\\"key2\\":\\"222\\"}","contentType":"application/x-www-form-urlencoded"},"checkPointList":[{"checkPoint":"userId","checkType":"EXPORTED_PARAM","expectValue":"111","operator":"ctn"}],"exportList":[{"exportName":"userId","exportType":"STATUS_CODE"}],"headerList":[{"headerName":"userName","headerValue":"John"}],"method":"GET","url":"https://www.aliyundoc.com"}],"relationName":"Chain 1"}],"sceneName":"xing-test-OpenAPI-1"}', 'required' => true, 'docRequired' => true, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SceneId' => ['description' => 'The ID of the scenario that was created.', 'type' => 'string', 'example' => 'SDR3CX', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '创建或者修改场景入参必须是实体类Scene的JSON串', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '4001', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- true: successful'."\n" ."\n" .'- false: failed', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CreateSceneFail', 'errorMessage' => 'Create scene cannot be empty', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneId\\": \\"SDR3CX\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"Message\\": \\"创建或者修改场景入参必须是实体类Scene的JSON串\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'CreatePtsScene', 'summary' => 'Creates a stress testing scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePtsScene'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'CreatePtsSceneBaseLineFromReport' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID. For more information, see [Parameters](~~201321~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'VCB78HB'], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['description' => 'The report ID. For more information, see [Parameters](~~201321~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'HNB78HB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message returned. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4F7D2CE0-AE4C-4143-954A-8E4595AF86A6'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CreatePtsSceneBaseLineFromReportFail', 'errorMessage' => 'The scene or the report cannot be empty.', 'description' => ''], ], ], 'title' => 'CreatePtsSceneBaseLineFromReport', 'summary' => 'Sets a report as the baseline for a scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePtsSceneBaseLineFromReport'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:CreatePtsSceneBaseLineFromReport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-954A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeletePtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the scenario. The system generates this ID after the scenario is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'XANH3H'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A3ED870E-C3BF-44F4-B460-A30785E0256B'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'DeletePtsSceneFail', 'errorMessage' => 'Delete Scene failed, please check the scene ID is correct', 'description' => ''], ], ], 'title' => 'DeletePtsScene', 'summary' => 'This operation deletes a scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:DeletePtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A3ED870E-C3BF-44F4-B460-A30785E0256B\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeletePtsSceneBaseLine' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID. For more information, see [Parameters](~~201321~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NHGV4CDG'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4F7D2XE0-AE4C-4143-955A-8E4595AF86A6'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'DeletePtsSceneBaseLineFail', 'errorMessage' => 'The scene cannot be empty.', 'description' => ''], ], ], 'title' => 'DeletePtsSceneBaseLine', 'summary' => 'Deletes a scenario baseline.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsSceneBaseLine'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:DeletePtsSceneBaseLine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2XE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeletePtsScenes' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of IDs of the scenarios to delete.', 'type' => 'array', 'items' => ['description' => 'A collection of scenario IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '["5DG9WQJ","9HG9TYJ"]'], 'required' => true, 'docRequired' => true, 'example' => '["XVB4DF","AFG3CV"]', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '35290A5B-AB50-46BD-81E0-E316F86128C4'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'DeletePtsScenesFail', 'errorMessage' => 'Scene is running', 'description' => ''], ], ], 'title' => 'DeletePtsScenes', 'summary' => 'Deletes multiple scenarios in a batch.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsScenes'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:DeletePtsScenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"35290A5B-AB50-46BD-81E0-E316F86128C4\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetAllRegions' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '73D16B8D-0FCD-5596-B7BE-A47042989318', 'title' => ''], 'AllRegions' => [ 'description' => 'A list of region information.', 'type' => 'object', 'additionalProperties' => ['description' => 'Region information.', 'type' => 'string', 'example' => '{'."\n" .' "cn-shenzhen": "华南1(深圳)",'."\n" .' "cn-qingdao": "华北1(青岛)",'."\n" .' "cn-beijing": "华北2(北京)",'."\n" .' "cn-shanghai": "华东2(上海)",'."\n" .' "cn-hongkong": "中国香港",'."\n" .' "ap-southeast-1": "新加坡",'."\n" .' "cn-huhehaote": "华北5(呼和浩特)",'."\n" .' "cn-zhangjiakou": "华北3(张家口)",'."\n" .' "cn-hangzhou": "华东1(杭州)",'."\n" .' "cn-chengdu": "西南1(成都)"'."\n" .' }', 'title' => ''], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Code', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], 'title' => 'GetAllRegions', 'summary' => 'Retrieves all regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"73D16B8D-0FCD-5596-B7BE-A47042989318\\",\\n \\"AllRegions\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"cn-shenzhen\\\\\\": \\\\\\"华南1(深圳)\\\\\\",\\\\n \\\\\\"cn-qingdao\\\\\\": \\\\\\"华北1(青岛)\\\\\\",\\\\n \\\\\\"cn-beijing\\\\\\": \\\\\\"华北2(北京)\\\\\\",\\\\n \\\\\\"cn-shanghai\\\\\\": \\\\\\"华东2(上海)\\\\\\",\\\\n \\\\\\"cn-hongkong\\\\\\": \\\\\\"中国香港\\\\\\",\\\\n \\\\\\"ap-southeast-1\\\\\\": \\\\\\"新加坡\\\\\\",\\\\n \\\\\\"cn-huhehaote\\\\\\": \\\\\\"华北5(呼和浩特)\\\\\\",\\\\n \\\\\\"cn-zhangjiakou\\\\\\": \\\\\\"华北3(张家口)\\\\\\",\\\\n \\\\\\"cn-hangzhou\\\\\\": \\\\\\"华东1(杭州)\\\\\\",\\\\n \\\\\\"cn-chengdu\\\\\\": \\\\\\"西南1(成都)\\\\\\"\\\\n }\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetJMeterLogs' => [ 'summary' => 'Retrieves the run logs for a JMeter test. By default, this operation queries the logs from machine 0 and returns the total number of machines.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'exclusiveMaximum' => false, 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'title' => '', 'example' => '10'], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The report ID.', 'type' => 'string', 'required' => true, 'example' => 'KS2YE3J2'], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The start time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637115306000'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The end time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637115309000'], ], [ 'name' => 'AgentIndex', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'If you specify an invalid index, the logs of engine 0 are returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'Level', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The log level. Valid values:'."\n" ."\n" .'- ERROR'."\n" .'- WARN'."\n" .'- INFO: The default value.'."\n" .'- DEBUG'."\n" .'- TRACE', 'type' => 'string', 'required' => false, 'example' => 'info'], ], [ 'name' => 'Thread', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The thread name.', 'type' => 'string', 'required' => false, 'example' => 'main'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The keyword to search for in the logs.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of log entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'Message' => ['description' => 'The error message. If the request is successful, this parameter is empty.', 'type' => 'string', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Logs' => [ 'title' => '', 'description' => 'The log entries.', 'type' => 'array', 'items' => ['description' => 'The log record.', 'type' => 'object', 'title' => '', 'example' => ' {'."\n" .' "timeTS": 1720492300643,'."\n" .' "level": "INFO",'."\n" .' "logger": "org.apache.jmeter.JMeter",'."\n" .' "thread": "main",'."\n" .' "logText": "os.version=4.18.0-348.2.1.el8_5.x86_64\\n",'."\n" .' "instanceId": 0,'."\n" .' "time": "2024-07-09T10:31Z"'."\n" .' }'], 'example' => '{ "timeTS":1637114804326, "instanceId":0, "level":"INFO", "logger":"org.apache.jmeter.util.JMeterUtils", "sceneId":251546, "planId":1501546, "thread":"main", "time":"2021-11-17T10:06Z", "taskId":15015460000, "logText":"Setting Locale to en_EN\\n" }', ], 'Code' => ['description' => 'The status code. If the request is successful, this parameter is empty.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'AgentCount' => ['title' => '', 'description' => 'The number of engines. You can use this value to specify the engine from which you want to retrieve logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'title' => 'GetJMeterLogs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterLogs'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:GetJMeterLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Logs\\": [\\n {\\n \\"timeTS\\": 1720492300643,\\n \\"level\\": \\"INFO\\",\\n \\"logger\\": \\"org.apache.jmeter.JMeter\\",\\n \\"thread\\": \\"main\\",\\n \\"logText\\": \\"os.version=4.18.0-348.2.1.el8_5.x86_64\\\\n\\",\\n \\"instanceId\\": 0,\\n \\"time\\": \\"2024-07-09T10:31Z\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true,\\n \\"AgentCount\\": 3\\n}","type":"json"}]', ], 'GetJMeterReportDetails' => [ 'summary' => 'Obtains the details of a JMeter report.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['description' => 'The report ID.', 'type' => 'string', 'required' => true, 'example' => 'KS2YE3J2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'GetJMeterReportDetailsResponse', 'description' => 'GetJMeterReportDetailsResponse', 'type' => 'object', 'properties' => [ 'ReportOverView' => [ 'title' => '', 'description' => 'The details of the report.', 'type' => 'object', 'properties' => [ 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'title' => '', 'example' => 'GHB56VD'], 'ReportName' => ['description' => 'The report name.', 'type' => 'string', 'example' => 'Order scenario-20220202222222', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the queried time range.', 'type' => 'string', 'title' => '', 'example' => '2023-05-03 10:35:11'], 'EndTime' => ['description' => 'The end of the queried time range.', 'type' => 'string', 'title' => '', 'example' => '2023-05-03 10:45:11'], 'AgentCount' => ['description' => 'The number of used engines.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Vum' => ['description' => 'The consumed Virtual User Minutes (VUM).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '4452'], ], 'example' => '', ], 'SceneMetrics' => [ 'title' => '', 'description' => 'The dimensions of the whole scenario.', 'type' => 'object', 'properties' => [ 'AvgTps' => ['description' => 'The average transactions per second (TPS).', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '78'], 'AvgRt' => ['description' => 'The average response time (RT). Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '23'], 'Seg90Rt' => ['description' => 'The 90th percentile of RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '35'], 'Seg99Rt' => ['description' => 'The 99th percentile of RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '56'], 'SuccessRateReq' => ['description' => 'The request success rate. The parameter value must be a non-negative number less than or equal to 100.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '99.98'], 'FailCountReq' => ['description' => 'The request failure rate.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '34'], 'AllCount' => ['description' => 'The total number of requests.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '717'], ], 'example' => '', ], 'SamplerMetricsList' => [ 'title' => '', 'description' => 'The dimensions of APIs.', 'type' => 'array', 'items' => [ 'description' => 'The dimensions of the API. An API has only one entry.', 'type' => 'object', 'properties' => [ 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'Logon', 'title' => ''], 'AvgTps' => ['description' => 'The average TPS.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '12'], 'AvgRt' => ['description' => 'The average RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '44.2'], 'Seg75Rt' => ['description' => 'The 75th percentile of RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '22.4'], 'Seg90Rt' => ['description' => 'The 90th percentile of RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '65'], 'Seg99Rt' => ['description' => 'The 99th percentile of RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '77'], 'MaxRt' => ['description' => 'The maximum RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '78'], 'MinRt' => ['description' => 'The minimum RT. Unit: milliseconds.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '11'], 'SuccessRateReq' => ['description' => 'The request success rate. The parameter value must be a non-negative number less than or equal to 100.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '100'], 'FailCountReq' => ['description' => 'The request failure rate.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'AllCount' => ['description' => 'The total number of requests.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '731'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'Code' => ['description' => 'The system status code. If the request was successful, this parameter is not returned.', 'type' => 'string', 'title' => '', 'example' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, this parameter is not returned.', 'type' => 'string', 'example' => 'Query report failed', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'DocumentUrl' => ['description' => 'The URL used to access the document.', 'type' => 'string', 'example' => '空', 'title' => ''], 'CodeKey' => ['description' => 'The code key that corresponds to the key in Medusa. If no code key is available, or if the content corresponding to the code key fails to be obtained or is empty, the returned message is displayed as the default information.', 'type' => 'string', 'title' => '', 'example' => '空'], 'DynamicCtx' => ['description' => 'The returned dynamic contents that are separated by the && operator.', 'type' => 'string', 'title' => '', 'example' => '空'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportOverView\\": {\\n \\"ReportId\\": \\"GHB56VD\\",\\n \\"ReportName\\": \\"Order scenario-20220202222222\\",\\n \\"StartTime\\": \\"2023-05-03 10:35:11\\",\\n \\"EndTime\\": \\"2023-05-03 10:45:11\\",\\n \\"AgentCount\\": 1,\\n \\"Vum\\": 4452\\n },\\n \\"SceneMetrics\\": {\\n \\"AvgTps\\": 78,\\n \\"AvgRt\\": 23,\\n \\"Seg90Rt\\": 35,\\n \\"Seg99Rt\\": 56,\\n \\"SuccessRateReq\\": 99.98,\\n \\"FailCountReq\\": 34,\\n \\"AllCount\\": 717\\n },\\n \\"SamplerMetricsList\\": [\\n {\\n \\"ApiName\\": \\"Logon\\",\\n \\"AvgTps\\": 12,\\n \\"AvgRt\\": 44.2,\\n \\"Seg75Rt\\": 22.4,\\n \\"Seg90Rt\\": 65,\\n \\"Seg99Rt\\": 77,\\n \\"MaxRt\\": 78,\\n \\"MinRt\\": 11,\\n \\"SuccessRateReq\\": 100,\\n \\"FailCountReq\\": 10,\\n \\"AllCount\\": 731\\n }\\n ],\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"Query report failed\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"DocumentUrl\\": \\"空\\",\\n \\"CodeKey\\": \\"空\\",\\n \\"DynamicCtx\\": \\"空\\"\\n}","type":"json"}]', 'title' => 'GetJMeterReportDetails', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'GetJMeterSampleMetrics' => [ 'summary' => 'Retrieves the aggregate data for JMeter samplers based on specified conditions.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The report ID.', 'type' => 'string', 'required' => true, 'example' => '7R4RE352'], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637157070000'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637157073000'], ], [ 'name' => 'SamplerId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The sampler index. The index starts from 0. If you set this parameter to -1, data for the entire scenario is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'SampleMetricList' => [ 'title' => '', 'description' => 'A list of aggregate data for the samplers.', 'type' => 'array', 'items' => ['description' => 'A list of aggregate data for the samplers.', 'type' => 'string', 'title' => '', 'example' => '[ { "statusCodes":[ { "count":26, "name":"200" } ], "reqFailureRtMin":0, "requestBps":2389, "requestBytes":3536, "reqSuccessCount":26, "reqSuccessRtMin":12, "reqSuccessRtAvg":21, "reqSuccessTps":17.56756756756757, "rtMin":12, "rtAvg":21, "totalCount":26, "concurrency":103.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":64922, "reqFailureTps":0.0, "tps":17.56756756756757, "responseBps":43866, "reqSuccessRtMax":30, "totalVum":13, "rtMax":30, "taskId":1475183, "timestamp":1649681740000 }, { "statusCodes":[ { "count":13, "name":"200" } ], "reqFailureRtMin":0, "requestBps":1782, "requestBytes":5304, "reqSuccessCount":13, "reqSuccessRtMin":11, "reqSuccessRtAvg":23, "reqSuccessTps":13.10483870967742, "rtMin":11, "rtAvg":24, "totalCount":13, "concurrency":411.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":97383, "reqFailureTps":0.0, "tps":13.10483870967742, "responseBps":32723, "reqSuccessRtMax":37, "totalVum":21, "rtMax":37, "taskId":1475183, "timestamp":1649681741000 }, { "statusCodes":[ { "count":7, "name":"200" } ], "reqFailureRtMin":0, "requestBps":952, "requestBytes":6256, "reqSuccessCount":7, "reqSuccessRtMin":19, "reqSuccessRtAvg":20, "reqSuccessTps":7.0, "rtMin":19, "rtAvg":20, "totalCount":7, "concurrency":500.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":114862, "reqFailureTps":0.0, "tps":7.0, "responseBps":17479, "reqSuccessRtMax":21, "totalVum":29, "rtMax":21, "taskId":1475183, "timestamp":1649681742000 }, { "statusCodes":[ { "count":12, "name":"200" } ], "reqFailureRtMin":0, "requestBps":1632, "requestBytes":7888, "reqSuccessCount":12, "reqSuccessRtMin":15, "reqSuccessRtAvg":24, "reqSuccessTps":12.0, "rtMin":15, "rtAvg":25, "totalCount":12, "concurrency":500.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":144826, "reqFailureTps":0.0, "tps":12.0, "responseBps":29964, "reqSuccessRtMax":45, "totalVum":38, "rtMax":45, "taskId":1475183, "timestamp":1649681743000 }, { "statusCodes":[ { "count":10, "name":"200" } ], "reqFailureRtMin":0, "requestBps":1360, "requestBytes":9248, "reqSuccessCount":10, "reqSuccessRtMin":14, "reqSuccessRtAvg":21, "reqSuccessTps":10.0, "rtMin":14, "rtAvg":22, "totalCount":10, "concurrency":500.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":169796, "reqFailureTps":0.0, "tps":10.0, "responseBps":24970, "reqSuccessRtMax":29, "totalVum":46, "rtMax":29, "taskId":1475183, "timestamp":1649681744000 }, { "statusCodes":[ { "count":9, "name":"200" } ], "reqFailureRtMin":0, "requestBps":1224, "requestBytes":10472, "reqSuccessCount":9, "reqSuccessRtMin":11, "reqSuccessRtAvg":23, "reqSuccessTps":9.0, "rtMin":11, "rtAvg":23, "totalCount":9, "concurrency":500.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":192269, "reqFailureTps":0.0, "tps":9.0, "responseBps":22473, "reqSuccessRtMax":45, "totalVum":54, "rtMax":45, "taskId":1475183, "timestamp":1649681745000 }, { "statusCodes":[ { "count":14, "name":"200" } ], "reqFailureRtMin":0, "requestBps":1904, "requestBytes":12376, "reqSuccessCount":14, "reqSuccessRtMin":10, "reqSuccessRtAvg":20, "reqSuccessTps":14.0, "rtMin":10, "rtAvg":21, "totalCount":14, "concurrency":500.0, "bucket":"d9fb4ee42f0e8eb3", "reqFailureCount":0, "reqFailureRtMax":0, "responseBytes":227227, "reqFailureTps":0.0, "tps":14.0, "responseBps":34958, "reqSuccessRtMax":34, "totalVum":63, "rtMax":34, "taskId":1475183, "timestamp":1649681746000 }]'], ], 'SamplerMap' => ['title' => '', 'description' => 'The list of samplers. You can use this list to specify the samplers that you want to query.', 'type' => 'object', 'example' => '{0:"Http Request"}'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'title' => 'GetJMeterSampleMetrics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterSampleMetrics'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:GetJMeterSampleMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"空\\",\\n \\"SampleMetricList\\": [\\n \\"[ { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":26, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":2389, \\\\\\"requestBytes\\\\\\":3536, \\\\\\"reqSuccessCount\\\\\\":26, \\\\\\"reqSuccessRtMin\\\\\\":12, \\\\\\"reqSuccessRtAvg\\\\\\":21, \\\\\\"reqSuccessTps\\\\\\":17.56756756756757, \\\\\\"rtMin\\\\\\":12, \\\\\\"rtAvg\\\\\\":21, \\\\\\"totalCount\\\\\\":26, \\\\\\"concurrency\\\\\\":103.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":64922, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":17.56756756756757, \\\\\\"responseBps\\\\\\":43866, \\\\\\"reqSuccessRtMax\\\\\\":30, \\\\\\"totalVum\\\\\\":13, \\\\\\"rtMax\\\\\\":30, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681740000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":13, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":1782, \\\\\\"requestBytes\\\\\\":5304, \\\\\\"reqSuccessCount\\\\\\":13, \\\\\\"reqSuccessRtMin\\\\\\":11, \\\\\\"reqSuccessRtAvg\\\\\\":23, \\\\\\"reqSuccessTps\\\\\\":13.10483870967742, \\\\\\"rtMin\\\\\\":11, \\\\\\"rtAvg\\\\\\":24, \\\\\\"totalCount\\\\\\":13, \\\\\\"concurrency\\\\\\":411.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":97383, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":13.10483870967742, \\\\\\"responseBps\\\\\\":32723, \\\\\\"reqSuccessRtMax\\\\\\":37, \\\\\\"totalVum\\\\\\":21, \\\\\\"rtMax\\\\\\":37, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681741000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":7, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":952, \\\\\\"requestBytes\\\\\\":6256, \\\\\\"reqSuccessCount\\\\\\":7, \\\\\\"reqSuccessRtMin\\\\\\":19, \\\\\\"reqSuccessRtAvg\\\\\\":20, \\\\\\"reqSuccessTps\\\\\\":7.0, \\\\\\"rtMin\\\\\\":19, \\\\\\"rtAvg\\\\\\":20, \\\\\\"totalCount\\\\\\":7, \\\\\\"concurrency\\\\\\":500.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":114862, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":7.0, \\\\\\"responseBps\\\\\\":17479, \\\\\\"reqSuccessRtMax\\\\\\":21, \\\\\\"totalVum\\\\\\":29, \\\\\\"rtMax\\\\\\":21, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681742000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":12, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":1632, \\\\\\"requestBytes\\\\\\":7888, \\\\\\"reqSuccessCount\\\\\\":12, \\\\\\"reqSuccessRtMin\\\\\\":15, \\\\\\"reqSuccessRtAvg\\\\\\":24, \\\\\\"reqSuccessTps\\\\\\":12.0, \\\\\\"rtMin\\\\\\":15, \\\\\\"rtAvg\\\\\\":25, \\\\\\"totalCount\\\\\\":12, \\\\\\"concurrency\\\\\\":500.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":144826, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":12.0, \\\\\\"responseBps\\\\\\":29964, \\\\\\"reqSuccessRtMax\\\\\\":45, \\\\\\"totalVum\\\\\\":38, \\\\\\"rtMax\\\\\\":45, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681743000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":10, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":1360, \\\\\\"requestBytes\\\\\\":9248, \\\\\\"reqSuccessCount\\\\\\":10, \\\\\\"reqSuccessRtMin\\\\\\":14, \\\\\\"reqSuccessRtAvg\\\\\\":21, \\\\\\"reqSuccessTps\\\\\\":10.0, \\\\\\"rtMin\\\\\\":14, \\\\\\"rtAvg\\\\\\":22, \\\\\\"totalCount\\\\\\":10, \\\\\\"concurrency\\\\\\":500.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":169796, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":10.0, \\\\\\"responseBps\\\\\\":24970, \\\\\\"reqSuccessRtMax\\\\\\":29, \\\\\\"totalVum\\\\\\":46, \\\\\\"rtMax\\\\\\":29, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681744000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":9, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":1224, \\\\\\"requestBytes\\\\\\":10472, \\\\\\"reqSuccessCount\\\\\\":9, \\\\\\"reqSuccessRtMin\\\\\\":11, \\\\\\"reqSuccessRtAvg\\\\\\":23, \\\\\\"reqSuccessTps\\\\\\":9.0, \\\\\\"rtMin\\\\\\":11, \\\\\\"rtAvg\\\\\\":23, \\\\\\"totalCount\\\\\\":9, \\\\\\"concurrency\\\\\\":500.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":192269, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":9.0, \\\\\\"responseBps\\\\\\":22473, \\\\\\"reqSuccessRtMax\\\\\\":45, \\\\\\"totalVum\\\\\\":54, \\\\\\"rtMax\\\\\\":45, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681745000 }, { \\\\\\"statusCodes\\\\\\":[ { \\\\\\"count\\\\\\":14, \\\\\\"name\\\\\\":\\\\\\"200\\\\\\" } ], \\\\\\"reqFailureRtMin\\\\\\":0, \\\\\\"requestBps\\\\\\":1904, \\\\\\"requestBytes\\\\\\":12376, \\\\\\"reqSuccessCount\\\\\\":14, \\\\\\"reqSuccessRtMin\\\\\\":10, \\\\\\"reqSuccessRtAvg\\\\\\":20, \\\\\\"reqSuccessTps\\\\\\":14.0, \\\\\\"rtMin\\\\\\":10, \\\\\\"rtAvg\\\\\\":21, \\\\\\"totalCount\\\\\\":14, \\\\\\"concurrency\\\\\\":500.0, \\\\\\"bucket\\\\\\":\\\\\\"d9fb4ee42f0e8eb3\\\\\\", \\\\\\"reqFailureCount\\\\\\":0, \\\\\\"reqFailureRtMax\\\\\\":0, \\\\\\"responseBytes\\\\\\":227227, \\\\\\"reqFailureTps\\\\\\":0.0, \\\\\\"tps\\\\\\":14.0, \\\\\\"responseBps\\\\\\":34958, \\\\\\"reqSuccessRtMax\\\\\\":34, \\\\\\"totalVum\\\\\\":63, \\\\\\"rtMax\\\\\\":34, \\\\\\"taskId\\\\\\":1475183, \\\\\\"timestamp\\\\\\":1649681746000 }]\\"\\n ],\\n \\"SamplerMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetJMeterSamplingLogs' => [ 'summary' => 'Retrieves the sampling logs for a JMeter sampler based on specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of sampling log entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => ['description' => 'The start time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1637157073000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1637157076000', 'title' => ''], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['description' => 'The report ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7R4RE352', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the stress testing engine. This parameter is not yet available.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14238000', 'title' => ''], ], [ 'name' => 'SamplerId', 'in' => 'query', 'schema' => ['description' => 'The serial number of the sampler. The value starts from 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Success', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the sampling is successful.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Thread', 'in' => 'query', 'schema' => ['description' => 'The thread name. Fuzzy search is supported. The value is tokenized by spaces.', 'type' => 'string', 'required' => false, 'example' => 'main', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The keyword. Use this parameter to perform a fuzzy search by **SceneName** or an exact search by **SceneId**.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'MinRT', 'in' => 'query', 'schema' => ['description' => 'The minimum response time (RT). Unit: ms.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'MaxRT', 'in' => 'query', 'schema' => ['description' => 'The maximum response time (RT). Unit: ms.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => '', 'required' => false], ], [ 'name' => 'ResponseCode', 'in' => 'query', 'schema' => ['description' => 'The response code.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of log entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'PageSize' => ['description' => 'The number of log entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'SampleResults' => [ 'title' => '', 'description' => 'The sampling results of the sampler.', 'type' => 'array', 'items' => ['description' => 'The sampling result of the sampler.', 'type' => 'string', 'example' => '{ "assertionResults":[], "endTimeTS":1650280351514, "dataEncoding":"utf-8", "latency":11, "samplerData":"GET http://testdomain/\\n\\nGET data:\\n\\n\\n[no cookies]\\n", "httpMethod":"GET", "subResults":[], "idleTime":0, "cookies":"", "responseCode":"200", "responseDataAsString":"response data", "startTimeTS":1650280351503, "requestByteCount":136, "instanceId":0, "samplerId":0, "connectTime":0, "sceneId":276685, "startTime":"2022-04-18T19:12Z", "planId":1736797, "requestData":"", "contentType":"text/html", "responseDataTruncated":false, "dataType":"text", "mediaType":"text/html", "requestDataTruncated":false, "responseByteCount":2497, "threadName":"线程组 1-1", "url":"http:/testdomain", "requestHeaders":"Connection: keep-alive\\nx-pts-test: 1\\nHost: testdomain\\nUser-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK)\\n", "responseHeaders":"HTTP/1.1 200 OK\\nContent-Length: 2381\\nContent-Type: text/html\\nServer: bfe\\nDate: Mon, 18 Apr 2022 11:12:31 GMT\\n", "success":true, "headersSize":116, "bodySize":2381, "endTime":"2022-04-18T19:12Z", "responseMessage":"OK", "taskId":17367970000, "elapsedTime":11 }', 'title' => ''], 'example' => '{         "assertionResults":[],         "endTimeTS":1650280351514,         "dataEncoding":"utf-8",         "latency":11,         "samplerData":"GET http://testdomain/\\n\\nGET data:\\n\\n\\n[no cookies]\\n",         "httpMethod":"GET",         "subResults":[],         "idleTime":0,         "cookies":"",         "responseCode":"200",         "responseDataAsString":"response data",         "startTimeTS":1650280351503,         "requestByteCount":136,         "instanceId":0,         "samplerId":0,         "connectTime":0,         "sceneId":276685,         "startTime":"2022-04-18T19:12Z",         "planId":1736797,         "requestData":"",         "contentType":"text/html",         "responseDataTruncated":false,         "dataType":"text",         "mediaType":"text/html",         "requestDataTruncated":false,         "responseByteCount":2497,         "threadName":"Thread Group 1-1",         "url":"http:/testdomain",         "requestHeaders":"Connection: keep-alive\\nx-pts-test: 1\\nHost: testdomain\\nUser-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK)\\n",         "responseHeaders":"HTTP/1.1 200 OK\\nContent-Length: 2381\\nContent-Type: text/html\\nServer: bfe\\nDate: Mon, 18 Apr 2022 11:12:31 GMT\\n",         "success":true,         "headersSize":116,         "bodySize":2381,         "endTime":"2022-04-18T19:12Z",         "responseMessage":"OK",         "taskId":17367970000,         "elapsedTime":11       }', ], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"HttpStatusCode\\": 0,\\n \\"SampleResults\\": [\\n \\"{ \\\\\\"assertionResults\\\\\\":[], \\\\\\"endTimeTS\\\\\\":1650280351514, \\\\\\"dataEncoding\\\\\\":\\\\\\"utf-8\\\\\\", \\\\\\"latency\\\\\\":11, \\\\\\"samplerData\\\\\\":\\\\\\"GET http://testdomain/\\\\\\\\n\\\\\\\\nGET data:\\\\\\\\n\\\\\\\\n\\\\\\\\n[no cookies]\\\\\\\\n\\\\\\", \\\\\\"httpMethod\\\\\\":\\\\\\"GET\\\\\\", \\\\\\"subResults\\\\\\":[], \\\\\\"idleTime\\\\\\":0, \\\\\\"cookies\\\\\\":\\\\\\"\\\\\\", \\\\\\"responseCode\\\\\\":\\\\\\"200\\\\\\", \\\\\\"responseDataAsString\\\\\\":\\\\\\"response data\\\\\\", \\\\\\"startTimeTS\\\\\\":1650280351503, \\\\\\"requestByteCount\\\\\\":136, \\\\\\"instanceId\\\\\\":0, \\\\\\"samplerId\\\\\\":0, \\\\\\"connectTime\\\\\\":0, \\\\\\"sceneId\\\\\\":276685, \\\\\\"startTime\\\\\\":\\\\\\"2022-04-18T19:12Z\\\\\\", \\\\\\"planId\\\\\\":1736797, \\\\\\"requestData\\\\\\":\\\\\\"\\\\\\", \\\\\\"contentType\\\\\\":\\\\\\"text/html\\\\\\", \\\\\\"responseDataTruncated\\\\\\":false, \\\\\\"dataType\\\\\\":\\\\\\"text\\\\\\", \\\\\\"mediaType\\\\\\":\\\\\\"text/html\\\\\\", \\\\\\"requestDataTruncated\\\\\\":false, \\\\\\"responseByteCount\\\\\\":2497, \\\\\\"threadName\\\\\\":\\\\\\"线程组 1-1\\\\\\", \\\\\\"url\\\\\\":\\\\\\"http:/testdomain\\\\\\", \\\\\\"requestHeaders\\\\\\":\\\\\\"Connection: keep-alive\\\\\\\\nx-pts-test: 1\\\\\\\\nHost: testdomain\\\\\\\\nUser-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK)\\\\\\\\n\\\\\\", \\\\\\"responseHeaders\\\\\\":\\\\\\"HTTP/1.1 200 OK\\\\\\\\nContent-Length: 2381\\\\\\\\nContent-Type: text/html\\\\\\\\nServer: bfe\\\\\\\\nDate: Mon, 18 Apr 2022 11:12:31 GMT\\\\\\\\n\\\\\\", \\\\\\"success\\\\\\":true, \\\\\\"headersSize\\\\\\":116, \\\\\\"bodySize\\\\\\":2381, \\\\\\"endTime\\\\\\":\\\\\\"2022-04-18T19:12Z\\\\\\", \\\\\\"responseMessage\\\\\\":\\\\\\"OK\\\\\\", \\\\\\"taskId\\\\\\":17367970000, \\\\\\"elapsedTime\\\\\\":11 }\\"\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetJMeterSamplingLogs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterSamplingLogs'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetJMeterSceneRunningData' => [ 'summary' => 'Retrieves the data generated during a JMeter stress test based on the scenario ID.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message returned. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'Code' => ['description' => 'The status code of the request. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'DocumentUrl' => ['description' => 'The link to the documentation.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RunningData' => [ 'title' => '', 'description' => 'The data of the running task.', 'type' => 'object', 'properties' => [ 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'DYYPZIH', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned for the failed stress testing flow. This parameter is not returned if the flow is successful.', 'type' => 'string', 'example' => '引擎租用失败', 'title' => ''], 'ReportId' => ['description' => 'The ID of the stress testing task. This is also the report ID.', 'type' => 'string', 'example' => 'DYYPLDKS', 'title' => ''], 'HasError' => ['description' => 'Indicates whether an error occurred in the stress testing flow.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'SceneName' => ['description' => 'The name of the scenario.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'HoldFor' => ['description' => 'The duration of the stress test. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'AgentCount' => ['description' => 'The number of stress testing engines.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'AgentIdList' => [ 'title' => '', 'description' => 'A list of stress testing engine IDs.', 'type' => 'array', 'items' => ['description' => 'A stress testing engine ID.', 'type' => 'string', 'example' => '["116.19.153.94_3088020"]', 'title' => ''], 'example' => '', ], 'Concurrency' => ['description' => 'The number of concurrent users.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'HasReport' => ['description' => 'Indicates whether a report has been generated.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'IsDebugging' => ['description' => 'Indicates whether the test is a debug run.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Status' => ['description' => 'The status of the stress test scenario.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'Vum' => ['description' => 'The number of virtual user minutes (VUMs) consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'StartTimeTS' => ['description' => 'The UNIX timestamp that indicates the start time of the stress test. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639970040000', 'title' => ''], 'StageName' => ['description' => 'The current stage of the task.', 'type' => 'string', 'example' => 'Task execution', 'title' => ''], 'AllSampleStat' => ['description' => 'The overall sampling statistics of the scenario.', 'type' => 'object', 'example' => '{'."\n" .' "statusCodes": {'."\n" .' "200": 634'."\n" .' }', 'title' => ''], 'SampleStatList' => [ 'title' => '', 'description' => 'The statistics of each sampler.', 'type' => 'array', 'items' => ['description' => 'The statistics of a sampler.', 'type' => 'object', 'example' => '['."\n" .' {'."\n" .' "statusCodes": {'."\n" .' "200": 634'."\n" .' },'."\n" .' "successRtAvg": 1,'."\n" .' "successRtMin": 1,'."\n" .' "responseBytesPerSecond": 453280,'."\n" .' "successRtSum": 985,'."\n" .' "samplerId": 0,'."\n" .' "successRtMax": 9,'."\n" .' "failRtSum": 0,'."\n" .' "failCount": 0,'."\n" .' "samplerLabel": "HTTP Request",'."\n" .' "count": 634,'."\n" .' "exceptions": {},'."\n" .' "successTps": 634,'."\n" .' "failRtAvg": 0,'."\n" .' "failRtMin": 0,'."\n" .' "rtMax": 9,'."\n" .' "failTps": 0,'."\n" .' "rtAvg": 1.553627760252366,'."\n" .' "rtMin": 1,'."\n" .' "failRtMax": 0,'."\n" .' "duration": 1000,'."\n" .' "fullStat": {'."\n" .' "statusCodes": {'."\n" .' "200": 1999372'."\n" .' },'."\n" .' "requestBytesSum": 411006848,'."\n" .' "successRtAvg": 1,'."\n" .' "successRtMin": 1,'."\n" .' "responseBytesPerSecond": 463583.6830464281,'."\n" .' "successRtSum": 3023438,'."\n" .' "rtMedianSum": 1,'."\n" .' "successRtMax": 25,'."\n" .' "responseBytesSum": 1429451015,'."\n" .' "failRtSum": 0,'."\n" .' "failCount": 0,'."\n" .' "count": 1999372,'."\n" .' "rtSeg99": 3,'."\n" .' "exceptions": {},'."\n" .' "successTps": 648.4141294900567,'."\n" .' "rtSeg90": 2,'."\n" .' "rtSeg50": 1,'."\n" .' "rtSeg99Sum": 3,'."\n" .' "failRtAvg": 0,'."\n" .' "failRtMin": 0,'."\n" .' "rtMax": 25,'."\n" .' "failTps": 0,'."\n" .' "rtSeg75Sum": 2,'."\n" .' "rtAvg": 1.5121938288622627,'."\n" .' "rtMin": 1,'."\n" .' "failRtMax": 0,'."\n" .' "duration": 3083480,'."\n" .' "successCount": 1999372,'."\n" .' "rtSegStatCount": 1,'."\n" .' "rtSeg75": 2,'."\n" .' "rtSeg90Sum": 2,'."\n" .' "tps": 648.4141294900567,'."\n" .' "requestBytesPerSecond": 133293.17783802716'."\n" .' },'."\n" .' "successCount": 634,'."\n" .' "tps": 634,'."\n" .' "requestBytesPerSecond": 130388'."\n" .' }'."\n" .' ]', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0,\\n \\"DocumentUrl\\": \\"空\\",\\n \\"RunningData\\": {\\n \\"SceneId\\": \\"DYYPZIH\\",\\n \\"ErrorMessage\\": \\"引擎租用失败\\",\\n \\"ReportId\\": \\"DYYPLDKS\\",\\n \\"HasError\\": false,\\n \\"SceneName\\": \\"test\\",\\n \\"HoldFor\\": 600,\\n \\"AgentCount\\": 2,\\n \\"AgentIdList\\": [\\n \\"[\\\\\\"116.19.153.94_3088020\\\\\\"]\\"\\n ],\\n \\"Concurrency\\": 1000,\\n \\"HasReport\\": false,\\n \\"IsDebugging\\": false,\\n \\"Status\\": \\"RUNNING\\",\\n \\"Vum\\": 100,\\n \\"StartTimeTS\\": 1639970040000,\\n \\"StageName\\": \\"Task execution\\",\\n \\"AllSampleStat\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SampleStatList\\": [\\n [\\n {\\n \\"statusCodes\\": {\\n \\"200\\": 634\\n },\\n \\"successRtAvg\\": 1,\\n \\"successRtMin\\": 1,\\n \\"responseBytesPerSecond\\": 453280,\\n \\"successRtSum\\": 985,\\n \\"samplerId\\": 0,\\n \\"successRtMax\\": 9,\\n \\"failRtSum\\": 0,\\n \\"failCount\\": 0,\\n \\"samplerLabel\\": \\"HTTP Request\\",\\n \\"count\\": 634,\\n \\"exceptions\\": {},\\n \\"successTps\\": 634,\\n \\"failRtAvg\\": 0,\\n \\"failRtMin\\": 0,\\n \\"rtMax\\": 9,\\n \\"failTps\\": 0,\\n \\"rtAvg\\": 1.553627760252366,\\n \\"rtMin\\": 1,\\n \\"failRtMax\\": 0,\\n \\"duration\\": 1000,\\n \\"fullStat\\": {\\n \\"statusCodes\\": {\\n \\"200\\": 1999372\\n },\\n \\"requestBytesSum\\": 411006848,\\n \\"successRtAvg\\": 1,\\n \\"successRtMin\\": 1,\\n \\"responseBytesPerSecond\\": 463583.6830464281,\\n \\"successRtSum\\": 3023438,\\n \\"rtMedianSum\\": 1,\\n \\"successRtMax\\": 25,\\n \\"responseBytesSum\\": 1429451015,\\n \\"failRtSum\\": 0,\\n \\"failCount\\": 0,\\n \\"count\\": 1999372,\\n \\"rtSeg99\\": 3,\\n \\"exceptions\\": {},\\n \\"successTps\\": 648.4141294900567,\\n \\"rtSeg90\\": 2,\\n \\"rtSeg50\\": 1,\\n \\"rtSeg99Sum\\": 3,\\n \\"failRtAvg\\": 0,\\n \\"failRtMin\\": 0,\\n \\"rtMax\\": 25,\\n \\"failTps\\": 0,\\n \\"rtSeg75Sum\\": 2,\\n \\"rtAvg\\": 1.5121938288622627,\\n \\"rtMin\\": 1,\\n \\"failRtMax\\": 0,\\n \\"duration\\": 3083480,\\n \\"successCount\\": 1999372,\\n \\"rtSegStatCount\\": 1,\\n \\"rtSeg75\\": 2,\\n \\"rtSeg90Sum\\": 2,\\n \\"tps\\": 648.4141294900567,\\n \\"requestBytesPerSecond\\": 133293.17783802716\\n },\\n \\"successCount\\": 634,\\n \\"tps\\": 634,\\n \\"requestBytesPerSecond\\": 130388\\n }\\n ]\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetJMeterSceneRunningData', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetJMeterSceneRunningData'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetOpenJMeterScene' => [ 'summary' => 'Retrieves the details of a JMeter scenario.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Scene' => [ 'title' => '', 'description' => 'The details of the scenario.', 'type' => 'object', 'properties' => [ 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'DYYPZIH', 'title' => ''], 'EnvironmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'EEDT7', 'title' => ''], 'BaseInfo' => [ 'title' => '', 'description' => 'The basic information.', 'type' => 'object', 'properties' => [ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '小心压测', 'title' => ''], 'Principal' => ['description' => 'The owner of the stress testing scenario.', 'type' => 'string', 'example' => 'test-person', 'title' => ''], 'Resource' => ['description' => 'The source of the scenario.', 'type' => 'string', 'example' => 'create', 'title' => ''], 'CreateName' => ['description' => 'The name of the user who created the scenario.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], 'ModifyName' => ['description' => 'The name of the user who last modified the scenario.', 'type' => 'string', 'example' => 'Rees', 'title' => ''], 'OperateType' => ['description' => 'The operation type.', 'type' => 'string', 'example' => 'Save and start stress test', 'title' => ''], ], 'example' => '', ], 'FileList' => [ 'title' => '', 'description' => 'The list of files.', 'type' => 'array', 'items' => [ 'description' => 'The file details.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '61660', 'title' => ''], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'json.jar', 'title' => ''], 'FileOssAddress' => ['description' => 'The Object Storage Service (OSS) URL of the file.', 'type' => 'string', 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', 'title' => ''], 'SplitCsv' => ['description' => 'Indicates whether to chunk the CSV file.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Md5' => ['description' => 'The MD5 hash of the JAR package.', 'type' => 'string', 'example' => '43B584026CE5E570F3DE638FA7EEF9E0', 'title' => ''], 'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '700', 'title' => ''], 'FileType' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'jar', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TestFile' => ['description' => 'The test file.', 'type' => 'string', 'example' => 'baidu.jmx', 'title' => ''], 'IsVpcTest' => ['description' => 'Indicates whether to perform stress testing in a VPC.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Duration' => ['description' => 'The duration of the stress test, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'DnsCacheConfig' => [ 'title' => '', 'description' => 'The DNS configuration.', 'type' => 'object', 'properties' => [ 'ClearCacheEachIteration' => ['description' => 'Indicates whether to clear the cache in each iteration.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DnsServers' => [ 'title' => '', 'description' => 'The DNS servers.', 'type' => 'array', 'items' => ['description' => 'A DNS server.', 'type' => 'string', 'example' => '["8.8.8.8"]', 'title' => ''], 'example' => '', ], 'HostTable' => ['description' => 'The domain name bindings.', 'type' => 'object', 'example' => '{"server.com":"6.6.6.6"}', 'title' => ''], ], 'example' => '', ], 'Concurrency' => ['description' => 'The maximum number of concurrent users.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'AgentCount' => ['description' => 'The number of stress testing agents. Each agent supports a maximum of 500 concurrent users.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'RampUp' => ['description' => 'The ramp-up period, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Steps' => ['description' => 'The number of ramp-up steps. The pressure is applied based on the following rules:', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'RegionId' => ['description' => 'The region ID. Configure this parameter for stress testing in a VPC.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'VpcId' => ['description' => 'The VPC ID. Configure this parameter for stress testing in a VPC.', 'type' => 'string', 'example' => 'vpc-2ze2sahjdgahsebjkqhf4pyj', 'title' => ''], 'SecurityGroupId' => ['description' => 'The security group ID. Configure this parameter for stress testing in a VPC.', 'type' => 'string', 'example' => 'sg-2zeid0dd7bhahsgdahspaly', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID. Configure this parameter for stress testing in a VPC.', 'type' => 'string', 'example' => 'vsw-2zehsgdhsahw1r', 'title' => ''], 'SyncTimerType' => ['description' => 'The type of the synchronization timer.', 'type' => 'string', 'example' => 'GLOBAL', 'title' => ''], 'ConstantThroughputTimerType' => ['title' => 'constantThroughputTimerType', 'description' => 'The type of the constant throughput timer.', 'type' => 'string', 'example' => 'STAND_ALONE'], 'Pool' => ['description' => 'The source of the stress testing traffic. An empty string specifies that traffic originates from the internet. \\`intranet-vpc\\` specifies that traffic originates from a VPC.', 'type' => 'string', 'title' => '', 'example' => 'VPC'], 'Mode' => ['description' => 'The stress testing mode. \\`concurrency\\_mode\\` indicates concurrent mode, and \\`tps\\_mode\\` indicates RPS mode.', 'type' => 'string', 'title' => '', 'example' => 'concurrency_mode'], 'StartRps' => ['description' => 'The initial RPS. This parameter is valid only in RPS mode.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''], 'MaxRps' => ['description' => 'The maximum number of records per second (RPS). This parameter is valid only in RPS mode.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''], 'StartConcurrency' => ['description' => 'The initial number of concurrent users. This parameter is valid only in concurrent mode.', 'type' => 'integer', 'format' => 'int32', 'example' => 'true', 'title' => ''], 'RegionalCondition' => [ 'description' => 'The custom regional configuration for stress testing agents.', 'type' => 'array', 'items' => [ 'description' => 'The number of stress testing agents in a single region.', 'type' => 'object', 'properties' => [ 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Amount' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Scene\\": {\\n \\"SceneName\\": \\"test\\",\\n \\"SceneId\\": \\"DYYPZIH\\",\\n \\"EnvironmentId\\": \\"EEDT7\\",\\n \\"BaseInfo\\": {\\n \\"Remark\\": \\"小心压测\\",\\n \\"Principal\\": \\"test-person\\",\\n \\"Resource\\": \\"create\\",\\n \\"CreateName\\": \\"John Doe\\",\\n \\"ModifyName\\": \\"Rees\\",\\n \\"OperateType\\": \\"Save and start stress test\\"\\n },\\n \\"FileList\\": [\\n {\\n \\"Id\\": 61660,\\n \\"FileName\\": \\"json.jar\\",\\n \\"FileOssAddress\\": \\"https://test.oss-cn-shanghai.aliyuncs.com/json.jar\\",\\n \\"SplitCsv\\": false,\\n \\"Md5\\": \\"43B584026CE5E570F3DE638FA7EEF9E0\\",\\n \\"FileSize\\": 700,\\n \\"FileType\\": \\"jar\\"\\n }\\n ],\\n \\"TestFile\\": \\"baidu.jmx\\",\\n \\"IsVpcTest\\": false,\\n \\"Duration\\": 600,\\n \\"DnsCacheConfig\\": {\\n \\"ClearCacheEachIteration\\": false,\\n \\"DnsServers\\": [\\n \\"[\\\\\\"8.8.8.8\\\\\\"]\\"\\n ],\\n \\"HostTable\\": {\\n \\"server.com\\": \\"6.6.6.6\\"\\n }\\n },\\n \\"Concurrency\\": 1000,\\n \\"AgentCount\\": 2,\\n \\"RampUp\\": 100,\\n \\"Steps\\": 3,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"VpcId\\": \\"vpc-2ze2sahjdgahsebjkqhf4pyj\\",\\n \\"SecurityGroupId\\": \\"sg-2zeid0dd7bhahsgdahspaly\\",\\n \\"VSwitchId\\": \\"vsw-2zehsgdhsahw1r\\",\\n \\"SyncTimerType\\": \\"GLOBAL\\",\\n \\"ConstantThroughputTimerType\\": \\"STAND_ALONE\\",\\n \\"Pool\\": \\"VPC\\",\\n \\"Mode\\": \\"concurrency_mode\\",\\n \\"StartRps\\": 0,\\n \\"MaxRps\\": 0,\\n \\"StartConcurrency\\": 0,\\n \\"RegionalCondition\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Amount\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetOpenJMeterScene', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOpenJMeterScene'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetPtsDebugSampleLogs' => [ 'summary' => 'Queries the sampling logs of a debug task in a PTS scenario.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the debug task.', 'type' => 'string', 'required' => false, 'example' => ' NJJBH8B', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'SamplingLogs' => [ 'title' => 'samplingLogs', 'description' => 'The sampling logs.', 'type' => 'array', 'items' => [ 'description' => 'The sampling log.', 'type' => 'object', 'properties' => [ 'HttpRequestMethod' => ['title' => 'httpRequestMethod', 'description' => 'The request method.', 'type' => 'string', 'example' => 'GET'], 'HttpResponseStatus' => ['title' => 'httpResponseStatus', 'description' => 'The response status code.', 'type' => 'string', 'example' => '200'], 'Timestamp' => ['title' => 'timestamp', 'description' => 'The timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1650253024471'], 'ExportConfig' => ['title' => 'exportConfig', 'description' => 'The response parameter settings.', 'type' => 'string', 'example' => '{\\"skuId\\":\\"{R:json@$.page.list[0].skuId}\\"}'], 'HttpResponseFailMsg' => ['title' => 'httpResponseFailMsg', 'description' => 'The response error message.', 'type' => 'string', 'example' => ''], 'CheckResult' => ['title' => 'checkResult', 'description' => 'The result of the assertion check.', 'type' => 'string', 'example' => '[{"checkPointType":"StatusCode","checker":{"expect":"200","operate":"eq","parsedExpectValue":"200","realValue":"200"},"hit":true,"point":"状态码"}]'], 'HttpResponseBody' => ['title' => 'httpResponseBody', 'description' => 'The response body.', 'type' => 'string', 'example' => '{"timestamp":1679903049155,"status":404,"error":"Not Found","message":"No message available","path":"/"}'], 'ChainId' => ['title' => 'chainId', 'description' => 'The trace ID.', 'type' => 'string', 'example' => '65354719'], 'HttpRequestHeaders' => ['title' => 'httpRequestHeaders', 'description' => 'The request header.', 'type' => 'string', 'example' => '[{"name":"v2","sensitive":false,"value":"1"},{"name":"x-pts-test","sensitive":false,"value":"2"}]'], 'Rt' => ['title' => 'rt', 'description' => 'The response time in milliseconds.', 'type' => 'string', 'example' => '230'], 'HttpResponseHeaders' => ['title' => 'httpResponseHeaders', 'description' => 'The response header.', 'type' => 'string', 'example' => '[{"valuePos":18,"name":"transfer-encoding","buffer":{"empty":false,"full":false},"sensitive":false,"value":"chunked"},{"valuePos":13,"name":"Content-Type","buffer":{"empty":false,"full":false},"sensitive":false,"value":"application/json;charset=UTF-8"},{"valuePos":5,"name":"Date","buffer":{"empty":false,"full":false},"sensitive":false,"value":"Mon, 27 Mar 2023 07:44:08 GMT"}]'], 'HttpStartTime' => ['title' => 'httpStartTime', 'description' => 'The time when the request was initiated.', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'ExportContent' => ['title' => 'exportContent', 'description' => 'The content of the exported parameter.', 'type' => 'string', 'example' => '{"skuId":"1"}'], 'ImportContent' => ['title' => 'importContent', 'description' => 'The content of the imported parameter.', 'type' => 'string', 'example' => ''], 'HttpTiming' => ['title' => 'httpTiming', 'description' => 'The HTTP timing waterfall.', 'type' => 'string', 'example' => '{"traceId":"0:1:10a94f66pts-2069351-allsparktask","requests":[{"lease":{"conn":{"duration":-1,"finish":-1,"operation":"conn","start":-1},"dns":{"duration":-1,"finish":-1,"operation":"dns","start":-1},"duration":-1,"finish":-1,"operation":"lease","start":32277914755},"recv":{"duration":225975,"finish":32283700284,"message":"","operation":"recv","start":32283474309},"sent":{"duration":594179,"finish":32278776504,"message":"","operation":"sent","start":32278182325},"tag":"GET http://tomcodemall.com:30080/api/product/skuinfo/list?key=2&vv=4&t4=%EF%BB%BF101"}],"message":""}'], 'HttpRequestBody' => ['title' => 'httpRequestBody', 'description' => 'The request body.', 'type' => 'string', 'example' => '{"loginacct":"acce"}'], 'NodeId' => ['title' => 'nodeId', 'description' => 'The node ID.', 'type' => 'string', 'example' => '1345531'], 'HttpRequestUrl' => ['title' => 'httpRequestUrl', 'description' => 'The request URL.', 'type' => 'string', 'example' => 'http://www.example.com'], 'ChainName' => ['description' => 'The trace name.', 'type' => 'string', 'example' => 'Serial chain', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsDebugSampleLogsFail', 'errorMessage' => 'planId not exist', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"SamplingLogs\\": [\\n {\\n \\"HttpRequestMethod\\": \\"GET\\",\\n \\"HttpResponseStatus\\": \\"200\\",\\n \\"Timestamp\\": 1650253024471,\\n \\"ExportConfig\\": \\"{\\\\\\\\\\\\\\"skuId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{R:json@$.page.list[0].skuId}\\\\\\\\\\\\\\"}\\",\\n \\"HttpResponseFailMsg\\": \\"\\",\\n \\"CheckResult\\": \\"[{\\\\\\"checkPointType\\\\\\":\\\\\\"StatusCode\\\\\\",\\\\\\"checker\\\\\\":{\\\\\\"expect\\\\\\":\\\\\\"200\\\\\\",\\\\\\"operate\\\\\\":\\\\\\"eq\\\\\\",\\\\\\"parsedExpectValue\\\\\\":\\\\\\"200\\\\\\",\\\\\\"realValue\\\\\\":\\\\\\"200\\\\\\"},\\\\\\"hit\\\\\\":true,\\\\\\"point\\\\\\":\\\\\\"状态码\\\\\\"}]\\",\\n \\"HttpResponseBody\\": \\"{\\\\\\"timestamp\\\\\\":1679903049155,\\\\\\"status\\\\\\":404,\\\\\\"error\\\\\\":\\\\\\"Not Found\\\\\\",\\\\\\"message\\\\\\":\\\\\\"No message available\\\\\\",\\\\\\"path\\\\\\":\\\\\\"/\\\\\\"}\\",\\n \\"ChainId\\": \\"65354719\\",\\n \\"HttpRequestHeaders\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"v2\\\\\\",\\\\\\"sensitive\\\\\\":false,\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"x-pts-test\\\\\\",\\\\\\"sensitive\\\\\\":false,\\\\\\"value\\\\\\":\\\\\\"2\\\\\\"}]\\",\\n \\"Rt\\": \\"230\\",\\n \\"HttpResponseHeaders\\": \\"[{\\\\\\"valuePos\\\\\\":18,\\\\\\"name\\\\\\":\\\\\\"transfer-encoding\\\\\\",\\\\\\"buffer\\\\\\":{\\\\\\"empty\\\\\\":false,\\\\\\"full\\\\\\":false},\\\\\\"sensitive\\\\\\":false,\\\\\\"value\\\\\\":\\\\\\"chunked\\\\\\"},{\\\\\\"valuePos\\\\\\":13,\\\\\\"name\\\\\\":\\\\\\"Content-Type\\\\\\",\\\\\\"buffer\\\\\\":{\\\\\\"empty\\\\\\":false,\\\\\\"full\\\\\\":false},\\\\\\"sensitive\\\\\\":false,\\\\\\"value\\\\\\":\\\\\\"application/json;charset=UTF-8\\\\\\"},{\\\\\\"valuePos\\\\\\":5,\\\\\\"name\\\\\\":\\\\\\"Date\\\\\\",\\\\\\"buffer\\\\\\":{\\\\\\"empty\\\\\\":false,\\\\\\"full\\\\\\":false},\\\\\\"sensitive\\\\\\":false,\\\\\\"value\\\\\\":\\\\\\"Mon, 27 Mar 2023 07:44:08 GMT\\\\\\"}]\\",\\n \\"HttpStartTime\\": 12,\\n \\"ExportContent\\": \\"{\\\\\\"skuId\\\\\\":\\\\\\"1\\\\\\"}\\",\\n \\"ImportContent\\": \\"\\",\\n \\"HttpTiming\\": \\"{\\\\\\"traceId\\\\\\":\\\\\\"0:1:10a94f66pts-2069351-allsparktask\\\\\\",\\\\\\"requests\\\\\\":[{\\\\\\"lease\\\\\\":{\\\\\\"conn\\\\\\":{\\\\\\"duration\\\\\\":-1,\\\\\\"finish\\\\\\":-1,\\\\\\"operation\\\\\\":\\\\\\"conn\\\\\\",\\\\\\"start\\\\\\":-1},\\\\\\"dns\\\\\\":{\\\\\\"duration\\\\\\":-1,\\\\\\"finish\\\\\\":-1,\\\\\\"operation\\\\\\":\\\\\\"dns\\\\\\",\\\\\\"start\\\\\\":-1},\\\\\\"duration\\\\\\":-1,\\\\\\"finish\\\\\\":-1,\\\\\\"operation\\\\\\":\\\\\\"lease\\\\\\",\\\\\\"start\\\\\\":32277914755},\\\\\\"recv\\\\\\":{\\\\\\"duration\\\\\\":225975,\\\\\\"finish\\\\\\":32283700284,\\\\\\"message\\\\\\":\\\\\\"\\\\\\",\\\\\\"operation\\\\\\":\\\\\\"recv\\\\\\",\\\\\\"start\\\\\\":32283474309},\\\\\\"sent\\\\\\":{\\\\\\"duration\\\\\\":594179,\\\\\\"finish\\\\\\":32278776504,\\\\\\"message\\\\\\":\\\\\\"\\\\\\",\\\\\\"operation\\\\\\":\\\\\\"sent\\\\\\",\\\\\\"start\\\\\\":32278182325},\\\\\\"tag\\\\\\":\\\\\\"GET http://tomcodemall.com:30080/api/product/skuinfo/list?key=2&vv=4&t4=%EF%BB%BF101\\\\\\"}],\\\\\\"message\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"HttpRequestBody\\": \\"{\\\\\\"loginacct\\\\\\":\\\\\\"acce\\\\\\"}\\",\\n \\"NodeId\\": \\"1345531\\",\\n \\"HttpRequestUrl\\": \\"http://www.example.com\\",\\n \\"ChainName\\": \\"Serial chain\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Success\\": true,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', 'title' => 'GetPtsDebugSampleLogs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsDebugSampleLogs'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetPtsReportDetails' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario. This is a unique identifier that the system generates after you create the scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'G5HCVS'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the task that is generated each time you start the scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'OH5HA3VB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A'], 'ReportOverView' => [ 'description' => 'The report overview.', 'type' => 'object', 'properties' => [ 'ReportName' => ['description' => 'The report name.', 'type' => 'string', 'title' => '', 'example' => 'PTS-TEST'], 'EndTime' => ['description' => 'The end time of the stress test.', 'type' => 'string', 'title' => '', 'example' => '2024-09-20 10:41:33'], 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'title' => '', 'example' => '2024-09-20 10:39:33'], 'AgentCount' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'title' => '', 'example' => 'GHB56VD'], 'Vum' => ['description' => 'The number of virtual user minutes (VUMs) consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1012'], ], 'title' => '', ], 'SceneMetrics' => [ 'description' => 'The metric information for the scenario dimension.', 'type' => 'object', 'properties' => [ 'FailCountBiz' => ['description' => 'The number of business failures for the entire scenario.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'AllCount' => ['description' => 'The total number of requests for the entire scenario.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11872'], 'SuccessRateBiz' => ['description' => 'The business success rate for the entire scenario.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], 'AvgRt' => ['description' => 'The average RT for the entire scenario.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '170.49'], 'FailCountReq' => ['description' => 'The number of failed requests for the entire scenario.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'AvgTps' => ['description' => 'The average TPS for the entire scenario.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100.61'], 'Seg99Rt' => ['description' => 'The 99th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '284'], 'SuccessRateReq' => ['description' => 'The request success rate for the entire scenario.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '1'], 'Seg90Rt' => ['description' => 'The 90th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '170'], ], 'title' => '', ], 'ApiMetricsList' => [ 'description' => 'The metric information for the API dimension.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FailCountBiz' => ['description' => 'The number of business failures. A failure is recorded if a response does not meet the conditions of a checkpoint.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'Seg75Rt' => ['description' => 'The 75th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '169'], 'AllCount' => ['description' => 'The total number of requests.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11872'], 'AvgTps' => ['description' => 'The average transactions per second (TPS).', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '100.61'], 'MinRt' => ['description' => 'The minimum RT. Unit: ms.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '162'], 'Seg99Rt' => ['description' => 'The 99th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '284'], 'Seg50Rt' => ['description' => 'The 50th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '168'], 'MaxRt' => ['description' => 'The maximum RT. Unit: ms.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '600'], 'Seg90Rt' => ['description' => 'The 90th percentile RT.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '170'], 'SuccessRateBiz' => ['description' => 'The business success rate. This is calculated by dividing the number of successful business transactions by the total number of requests.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0'], 'AvgRt' => ['description' => 'The average response time (RT). Unit: ms.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '170.49'], 'FailCountReq' => ['description' => 'The number of failed requests.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'SuccessRateReq' => ['description' => 'The request success rate. This is calculated by dividing the number of successful requests by the total number of requests.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '1'], 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'title' => '', 'example' => 'Test-API'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'SceneSnapShot' => [ 'description' => 'The scenario snapshot information.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The scenario status.', 'type' => 'string', 'title' => '', 'example' => 'STOPPED'], 'LoadConfig' => [ 'description' => 'The stress testing configuration.', 'type' => 'object', 'properties' => [ 'ApiLoadConfigList' => [ 'description' => 'The initial records per second (RPS) for the API.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RpsBegin' => ['description' => 'The initial RPS.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'RpsLimit' => ['description' => 'The maximum RPS.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'MaxRunningTime' => ['description' => 'The runtime duration, in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'RelationLoadConfigList' => [ 'description' => 'The initial and maximum concurrent request configurations for the ingest endpoint.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConcurrencyBegin' => ['description' => 'The initial number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'ConcurrencyLimit' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'Configuration' => [ 'description' => 'The limits on concurrent requests or RPS for the entire scenario.', 'type' => 'object', 'properties' => [ 'AllRpsBegin' => ['description' => 'The initial RPS for the entire scenario.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], 'AllConcurrencyBegin' => ['description' => 'The initial number of concurrent requests for the entire scenario.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'AllConcurrencyLimit' => ['description' => 'The maximum number of concurrent requests for the entire scenario.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '500'], 'AllRpsLimit' => ['description' => 'The maximum RPS for the entire scenario.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1000'], ], 'title' => '', ], 'AgentCount' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'TestMode' => ['description' => 'The stress testing pattern.', 'type' => 'string', 'title' => '', 'example' => 'TPS'], ], 'title' => '', ], 'FileParameterList' => [ 'description' => 'The information about the files used in the scenario.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileOssAddress' => ['description' => 'The Object Storage Service (OSS) address of the file.', 'type' => 'string', 'title' => '', 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv'], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'test.csv'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => '2020-10-10 10:10:10'], 'AdvanceSetting' => [ 'description' => 'The advanced settings for the scenario.', 'type' => 'object', 'properties' => [ 'LogRate' => ['description' => 'The log sample rate.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'DomainBindingList' => [ 'description' => 'The mappings between domain names and IP addresses.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'title' => '', 'example' => 'www.example.com'], 'Ips' => [ 'description' => 'The IP addresses mapped to the domain name.', 'type' => 'array', 'items' => ['description' => 'The IP addresses mapped to the domain name.', 'type' => 'string', 'title' => '', 'example' => '[192.168.0.1]'], 'title' => '', ], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'ConnectionTimeoutInSecond' => ['description' => 'The timeout period for the entire scenario.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'SuccessCode' => ['description' => 'The custom success status code.', 'type' => 'string', 'title' => ''], ], 'title' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-09-20 09:28:10'], 'RelationList' => [ 'description' => 'The information about the ingest endpoint.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RelationName' => ['description' => 'The ingest endpoint name.', 'type' => 'string', 'title' => '', 'example' => 'Test-session-1'], 'FileParameterExplainList' => [ 'description' => 'The descriptions of the file parameters used in the ingest endpoint.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CycleOnce' => ['description' => 'Indicates whether to loop through the file only once.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'FileParamName' => ['description' => 'The parameter name in the file.', 'type' => 'string', 'title' => '', 'example' => 'username'], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'test.csv'], 'BaseFile' => ['description' => 'Indicates whether the file is used as a baseline column.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'ApiList' => [ 'description' => 'The API information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'title' => '', 'example' => 'MNB45'], 'CheckPointList' => [ 'description' => 'All checkpoints for the API.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckType' => ['description' => 'The check type.', 'type' => 'string', 'title' => '', 'example' => 'EXPORTED_PARAM'], 'Operator' => ['description' => 'The comparison operator.', 'type' => 'string', 'title' => '', 'example' => 'ctn'], 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'string', 'title' => '', 'example' => '111'], 'CheckPoint' => ['description' => 'The checkpoint.', 'type' => 'string', 'title' => '', 'example' => 'userId'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'HeaderList' => [ 'description' => 'The headers of the stress testing URL.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HeaderValue' => ['description' => 'The parameter value.', 'type' => 'string', 'title' => '', 'example' => 'PTS'], 'HeaderName' => ['description' => 'The parameter name.', 'type' => 'string', 'title' => '', 'example' => 'User-Agent'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'TimeoutInSecond' => ['description' => 'The timeout period.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'ExportList' => [ 'description' => 'The list of exported parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExportType' => ['description' => 'The source of the exported parameter.', 'type' => 'string', 'title' => '', 'example' => 'BODY_JSON'], 'ExportValue' => ['description' => 'The expression used to parse the exported parameter.', 'type' => 'string', 'title' => '', 'example' => 'data.userId'], 'ExportName' => ['description' => 'The name of the exported parameter.', 'type' => 'string', 'title' => '', 'example' => 'userId'], 'Count' => ['description' => 'The matching item for the exported parameter.', 'type' => 'string', 'title' => '', 'example' => '1'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'Url' => ['description' => 'The stress testing URL.', 'type' => 'string', 'title' => '', 'example' => 'http://www.example.com/'], 'Method' => ['description' => 'The request method.', 'type' => 'string', 'title' => '', 'example' => 'GET'], 'Body' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'BodyValue' => ['description' => 'The body value.', 'type' => 'string', 'title' => '', 'example' => '{key:value}'], 'ContentType' => ['description' => 'The body content type.', 'type' => 'string', 'title' => '', 'example' => 'application/x-www-form-urlencoded'], ], 'title' => '', ], 'RedirectCountLimit' => ['description' => 'The number of redirections.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'title' => '', 'example' => 'Test-API'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'RelationId' => ['description' => 'The ingest endpoint ID.', 'type' => 'string', 'title' => '', 'example' => 'HGBN4D'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'title' => '', 'example' => 'PTS-TEST'], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'title' => '', 'example' => '7HBNS3'], 'GlobalParameterList' => [ 'description' => 'The global variables.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamName' => ['description' => 'The parameter name.', 'type' => 'string', 'title' => '', 'example' => 'username'], 'ParamValue' => ['description' => 'The parameter value.', 'type' => 'string', 'title' => '', 'example' => 'user01'], ], 'description' => '', 'title' => '', ], 'title' => '', ], ], 'title' => '', ], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsReportDetailsFail', 'errorMessage' => 'Report does not exist', 'description' => ''], ], ], 'title' => 'GetPtsReportDetails', 'summary' => 'Retrieves the details of a report for a scenario stress test.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsReportDetails'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:GetPtsReportDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"ReportOverView\\": {\\n \\"ReportName\\": \\"PTS-TEST\\",\\n \\"EndTime\\": \\"2024-09-20 10:41:33\\",\\n \\"StartTime\\": \\"2024-09-20 10:39:33\\",\\n \\"AgentCount\\": 1,\\n \\"ReportId\\": \\"GHB56VD\\",\\n \\"Vum\\": 1012\\n },\\n \\"SceneMetrics\\": {\\n \\"FailCountBiz\\": 0,\\n \\"AllCount\\": 11872,\\n \\"SuccessRateBiz\\": 0,\\n \\"AvgRt\\": 170.49,\\n \\"FailCountReq\\": 0,\\n \\"AvgTps\\": 100.61,\\n \\"Seg99Rt\\": 284,\\n \\"SuccessRateReq\\": 1,\\n \\"Seg90Rt\\": 170\\n },\\n \\"ApiMetricsList\\": [\\n {\\n \\"FailCountBiz\\": 0,\\n \\"Seg75Rt\\": 169,\\n \\"AllCount\\": 11872,\\n \\"AvgTps\\": 100.61,\\n \\"MinRt\\": 162,\\n \\"Seg99Rt\\": 284,\\n \\"Seg50Rt\\": 168,\\n \\"MaxRt\\": 600,\\n \\"Seg90Rt\\": 170,\\n \\"SuccessRateBiz\\": 0,\\n \\"AvgRt\\": 170.49,\\n \\"FailCountReq\\": 0,\\n \\"SuccessRateReq\\": 1,\\n \\"ApiName\\": \\"Test-API\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"SceneSnapShot\\": {\\n \\"Status\\": \\"STOPPED\\",\\n \\"LoadConfig\\": {\\n \\"ApiLoadConfigList\\": [\\n {\\n \\"RpsBegin\\": 10,\\n \\"RpsLimit\\": 10\\n }\\n ],\\n \\"MaxRunningTime\\": 2,\\n \\"RelationLoadConfigList\\": [\\n {\\n \\"ConcurrencyBegin\\": 10,\\n \\"ConcurrencyLimit\\": 20\\n }\\n ],\\n \\"Configuration\\": {\\n \\"AllRpsBegin\\": 100,\\n \\"AllConcurrencyBegin\\": 0,\\n \\"AllConcurrencyLimit\\": 500,\\n \\"AllRpsLimit\\": 1000\\n },\\n \\"AgentCount\\": 1,\\n \\"TestMode\\": \\"TPS\\"\\n },\\n \\"FileParameterList\\": [\\n {\\n \\"FileOssAddress\\": \\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv\\",\\n \\"FileName\\": \\"test.csv\\"\\n }\\n ],\\n \\"ModifiedTime\\": \\"2020-10-10 10:10:10\\",\\n \\"AdvanceSetting\\": {\\n \\"LogRate\\": 1,\\n \\"DomainBindingList\\": [\\n {\\n \\"Domain\\": \\"www.example.com\\",\\n \\"Ips\\": [\\n \\"[192.168.0.1]\\"\\n ]\\n }\\n ],\\n \\"ConnectionTimeoutInSecond\\": 5,\\n \\"SuccessCode\\": \\"\\"\\n },\\n \\"CreateTime\\": \\"2024-09-20 09:28:10\\",\\n \\"RelationList\\": [\\n {\\n \\"RelationName\\": \\"Test-session-1\\",\\n \\"FileParameterExplainList\\": [\\n {\\n \\"CycleOnce\\": false,\\n \\"FileParamName\\": \\"username\\",\\n \\"FileName\\": \\"test.csv\\",\\n \\"BaseFile\\": true\\n }\\n ],\\n \\"ApiList\\": [\\n {\\n \\"ApiId\\": \\"MNB45\\",\\n \\"CheckPointList\\": [\\n {\\n \\"CheckType\\": \\"EXPORTED_PARAM\\",\\n \\"Operator\\": \\"ctn\\",\\n \\"ExpectValue\\": \\"111\\",\\n \\"CheckPoint\\": \\"userId\\"\\n }\\n ],\\n \\"HeaderList\\": [\\n {\\n \\"HeaderValue\\": \\"PTS\\",\\n \\"HeaderName\\": \\"User-Agent\\"\\n }\\n ],\\n \\"TimeoutInSecond\\": 5,\\n \\"ExportList\\": [\\n {\\n \\"ExportType\\": \\"BODY_JSON\\",\\n \\"ExportValue\\": \\"data.userId\\",\\n \\"ExportName\\": \\"userId\\",\\n \\"Count\\": \\"1\\"\\n }\\n ],\\n \\"Url\\": \\"http://www.example.com/\\",\\n \\"Method\\": \\"GET\\",\\n \\"Body\\": {\\n \\"BodyValue\\": \\"{key:value}\\",\\n \\"ContentType\\": \\"application/x-www-form-urlencoded\\"\\n },\\n \\"RedirectCountLimit\\": 5,\\n \\"ApiName\\": \\"Test-API\\"\\n }\\n ],\\n \\"RelationId\\": \\"HGBN4D\\"\\n }\\n ],\\n \\"SceneName\\": \\"PTS-TEST\\",\\n \\"SceneId\\": \\"7HBNS3\\",\\n \\"GlobalParameterList\\": [\\n {\\n \\"ParamName\\": \\"username\\",\\n \\"ParamValue\\": \\"user01\\"\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetPtsReportsBySceneId' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NGBCD4K'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of reports to return on each page. Valid values: 5 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '5', 'title' => '', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This field is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This field is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'ReportOverViewList' => [ 'description' => 'The overview of reports.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReportName' => ['description' => 'The report name.', 'type' => 'string', 'title' => '', 'example' => 'PTS-test-20240920094710'], 'EndTime' => ['description' => 'The time when the stress test ended.', 'type' => 'string', 'title' => '', 'example' => '2024-09-20 09:49:11'], 'StartTime' => ['description' => 'The time when the stress test started.', 'type' => 'string', 'title' => '', 'example' => '2024-09-20 09:47:11'], 'AgentCount' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'title' => '', 'example' => 'NGGB5FV'], 'Vum' => ['description' => 'The number of consumed VUMs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1007'], ], 'description' => '', 'title' => '', ], 'title' => '', ], 'Code' => ['description' => 'The status code of the request. This field is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsReportsBySceneIdFail', 'errorMessage' => 'The scene has not started', 'description' => ''], ], ], 'title' => 'GetPtsReportsBySceneId', 'summary' => 'Performs a batch query for all reports that are associated with a specific stress testing scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsReportsBySceneId'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:GetPtsReportsBySceneId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ReportOverViewList\\": [\\n {\\n \\"ReportName\\": \\"PTS-test-20240920094710\\",\\n \\"EndTime\\": \\"2024-09-20 09:49:11\\",\\n \\"StartTime\\": \\"2024-09-20 09:47:11\\",\\n \\"AgentCount\\": 1,\\n \\"ReportId\\": \\"NGGB5FV\\",\\n \\"Vum\\": 1007\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetPtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NKJBSH', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Scene' => [ 'description' => 'The structure of the scenario.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the scenario.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'LoadConfig' => [ 'description' => 'The stress testing configuration.', 'type' => 'object', 'properties' => [ 'ApiLoadConfigList' => [ 'description' => 'The stress testing configurations for APIs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RpsBegin' => ['description' => 'The initial records per second (RPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RpsLimit' => ['description' => 'The maximum RPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'ApiId' => ['description' => 'The API ID. You can use this ID to find the corresponding API information in Relation.', 'type' => 'string', 'example' => 'GBFDCV8', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MaxRunningTime' => ['description' => 'The runtime duration. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'RelationLoadConfigList' => [ 'description' => 'The stress testing configurations for transaction links.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConcurrencyBegin' => ['description' => 'The initial number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ConcurrencyLimit' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'RelationId' => ['description' => 'The link ID.', 'type' => 'string', 'example' => 'HNBGS7M', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Configuration' => [ 'description' => 'The configuration of concurrent requests or RPS for the entire scenario.', 'type' => 'object', 'properties' => [ 'AllRpsBegin' => ['description' => 'The initial RPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'AllConcurrencyBegin' => ['description' => 'The initial number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'AllConcurrencyLimit' => ['description' => 'The maximum number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'AllRpsLimit' => ['description' => 'The maximum RPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AgentCount' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TestMode' => ['description' => 'The stress testing mode. TPS indicates the RPS mode.'."\n" ."\n" .'> The returned value is CONCURRENCY or TPS.', 'type' => 'string', 'example' => 'TPS', 'title' => ''], 'AutoStep' => ['description' => 'Indicates whether the auto-increment mode is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Increment' => ['description' => 'The increment percentage. Valid values: 10 to 100. The value must be a multiple of 10. This parameter is valid only when testMode is set to concurrency\\_mode and autoStep is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'KeepTime' => ['description' => 'The duration of a single stress level. Unit: minutes. The value must be smaller than the value of maxRunningTime.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'VpcLoadConfig' => [ 'description' => 'The virtual private cloud (VPC) configuration. This parameter is valid only in VPC stress testing mode.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-akjhsdajgjsfggahjkga', 'title' => ''], 'VSwitchId' => ['description' => 'The virtual switch ID.', 'type' => 'string', 'example' => 'vsw-skjfhlahsljkhsfalkjdoiw', 'title' => ''], 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-jkasgfieiajidsjakjscb', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'FileParameterList' => [ 'description' => 'The file parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileOssAddress' => ['description' => 'The URL of your Object Storage Service (OSS) file. The file must be accessible over the Internet.', 'type' => 'string', 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', 'title' => ''], 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'city.csv', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ModifiedTime' => ['description' => 'The time when the scenario was last modified.', 'type' => 'string', 'example' => '2021-03-26 15:30:30', 'title' => ''], 'AdvanceSetting' => [ 'description' => 'The advanced settings.', 'type' => 'object', 'properties' => [ 'LogRate' => ['description' => 'The log sampling rate.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DomainBindingList' => [ 'description' => 'The mappings between domain names and IP addresses.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.aliyundoc.com', 'title' => ''], 'Ips' => [ 'description' => 'The bound IP addresses.', 'type' => 'array', 'items' => ['description' => 'A bound IP address.', 'type' => 'string', 'example' => '[1.1.1.1]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ConnectionTimeoutInSecond' => ['description' => 'The timeout period of the scenario. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'SuccessCode' => ['description' => 'The custom success status codes.', 'type' => 'string', 'example' => '429,304', 'title' => ''], ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The time when the scenario was created.', 'type' => 'string', 'example' => '2021-02-26 15:30:30', 'title' => ''], 'RelationList' => [ 'description' => 'The information about the transaction links.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RelationName' => ['description' => 'The link name.', 'type' => 'string', 'example' => 'Order chain', 'title' => ''], 'FileParameterExplainList' => [ 'description' => 'The description of the file parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CycleOnce' => ['description' => 'Indicates whether to loop once.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FileParamName' => ['description' => 'The parameter names in the file.', 'type' => 'string', 'example' => 'userName,age', 'title' => ''], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'city.csv', 'title' => ''], 'BaseFile' => ['description' => 'Indicates whether the file is used as the baseline.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ApiList' => [ 'description' => 'The API information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiId' => ['description' => 'The API ID. You can use this ID to find the corresponding API information in Relation.', 'type' => 'string', 'example' => 'GBFDCV8', 'title' => ''], 'CheckPointList' => [ 'description' => 'All checkpoints.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckType' => ['description' => 'The check type.', 'type' => 'string', 'example' => 'EXPORTED_PARAM', 'title' => ''], 'Operator' => ['description' => 'The comparison operator.', 'type' => 'string', 'example' => 'ctn', 'title' => ''], 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'string', 'example' => '111', 'title' => ''], 'CheckPoint' => ['description' => 'The checkpoint.', 'type' => 'string', 'example' => 'userId', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HeaderList' => [ 'description' => 'The header information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HeaderValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '1111', 'title' => ''], 'HeaderName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'userId', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TimeoutInSecond' => ['description' => 'The timeout period. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'ExportList' => [ 'description' => 'All exported parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExportType' => ['description' => 'The source of the exported parameter.', 'type' => 'string', 'example' => 'BODY_JSON', 'title' => ''], 'ExportValue' => ['description' => 'The expression.', 'type' => 'string', 'example' => 'username', 'title' => ''], 'ExportName' => ['description' => 'The name of the exported parameter.', 'type' => 'string', 'example' => 'data.username', 'title' => ''], 'Count' => ['description' => 'The number of matched items for the exported parameter.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Url' => ['description' => 'The request URL.', 'type' => 'string', 'example' => 'https://www.aliyundoc.com', 'title' => ''], 'Method' => ['description' => 'The request method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], 'Body' => [ 'description' => 'The content of the body.', 'type' => 'object', 'properties' => [ 'BodyValue' => ['description' => 'The value of the body.', 'type' => 'string', 'example' => '{\\"key1\\":\\"111\\",\\"key2\\":\\"222\\"}', 'title' => ''], 'ContentType' => ['description' => 'The type of the body.', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RedirectCountLimit' => ['description' => 'The number of redirections.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'Order', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RelationId' => ['description' => 'The link ID.', 'type' => 'string', 'example' => 'HNBGS7M', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'Order scenario', 'title' => ''], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'BGFJ7GV', 'title' => ''], 'GlobalParameterList' => [ 'description' => 'The global parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'userName', 'title' => ''], 'ParamValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'lisi', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Headers' => [ 'description' => 'The global headers that are set for the scenario.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the header.', 'type' => 'string', 'example' => 'key1', 'title' => ''], 'Value' => ['description' => 'The value of the header.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsSceneFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Scene\\": {\\n \\"Status\\": \\"Running\\",\\n \\"LoadConfig\\": {\\n \\"ApiLoadConfigList\\": [\\n {\\n \\"RpsBegin\\": 10,\\n \\"RpsLimit\\": 20,\\n \\"ApiId\\": \\"GBFDCV8\\"\\n }\\n ],\\n \\"MaxRunningTime\\": 2,\\n \\"RelationLoadConfigList\\": [\\n {\\n \\"ConcurrencyBegin\\": 10,\\n \\"ConcurrencyLimit\\": 20,\\n \\"RelationId\\": \\"HNBGS7M\\"\\n }\\n ],\\n \\"Configuration\\": {\\n \\"AllRpsBegin\\": 100,\\n \\"AllConcurrencyBegin\\": 100,\\n \\"AllConcurrencyLimit\\": 200,\\n \\"AllRpsLimit\\": 200\\n },\\n \\"AgentCount\\": 1,\\n \\"TestMode\\": \\"TPS\\",\\n \\"AutoStep\\": false,\\n \\"Increment\\": 10,\\n \\"KeepTime\\": 2,\\n \\"VpcLoadConfig\\": {\\n \\"VpcId\\": \\"vpc-akjhsdajgjsfggahjkga\\",\\n \\"VSwitchId\\": \\"vsw-skjfhlahsljkhsfalkjdoiw\\",\\n \\"SecurityGroupId\\": \\"sg-jkasgfieiajidsjakjscb\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n },\\n \\"FileParameterList\\": [\\n {\\n \\"FileOssAddress\\": \\"https://test.oss-cn-shanghai.aliyuncs.com/json.jar\\",\\n \\"FileName\\": \\"city.csv\\"\\n }\\n ],\\n \\"ModifiedTime\\": \\"2021-03-26 15:30:30\\",\\n \\"AdvanceSetting\\": {\\n \\"LogRate\\": 1,\\n \\"DomainBindingList\\": [\\n {\\n \\"Domain\\": \\"www.aliyundoc.com\\",\\n \\"Ips\\": [\\n \\"[1.1.1.1]\\"\\n ]\\n }\\n ],\\n \\"ConnectionTimeoutInSecond\\": 5,\\n \\"SuccessCode\\": \\"429,304\\"\\n },\\n \\"CreateTime\\": \\"2021-02-26 15:30:30\\",\\n \\"RelationList\\": [\\n {\\n \\"RelationName\\": \\"Order chain\\",\\n \\"FileParameterExplainList\\": [\\n {\\n \\"CycleOnce\\": true,\\n \\"FileParamName\\": \\"userName,age\\",\\n \\"FileName\\": \\"city.csv\\",\\n \\"BaseFile\\": true\\n }\\n ],\\n \\"ApiList\\": [\\n {\\n \\"ApiId\\": \\"GBFDCV8\\",\\n \\"CheckPointList\\": [\\n {\\n \\"CheckType\\": \\"EXPORTED_PARAM\\",\\n \\"Operator\\": \\"ctn\\",\\n \\"ExpectValue\\": \\"111\\",\\n \\"CheckPoint\\": \\"userId\\"\\n }\\n ],\\n \\"HeaderList\\": [\\n {\\n \\"HeaderValue\\": \\"1111\\",\\n \\"HeaderName\\": \\"userId\\"\\n }\\n ],\\n \\"TimeoutInSecond\\": 5,\\n \\"ExportList\\": [\\n {\\n \\"ExportType\\": \\"BODY_JSON\\",\\n \\"ExportValue\\": \\"username\\",\\n \\"ExportName\\": \\"data.username\\",\\n \\"Count\\": \\"0\\"\\n }\\n ],\\n \\"Url\\": \\"https://www.aliyundoc.com\\",\\n \\"Method\\": \\"GET\\",\\n \\"Body\\": {\\n \\"BodyValue\\": \\"{\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"111\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key2\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"222\\\\\\\\\\\\\\"}\\",\\n \\"ContentType\\": \\"application/x-www-form-urlencoded\\"\\n },\\n \\"RedirectCountLimit\\": 5,\\n \\"ApiName\\": \\"Order\\"\\n }\\n ],\\n \\"RelationId\\": \\"HNBGS7M\\"\\n }\\n ],\\n \\"SceneName\\": \\"Order scenario\\",\\n \\"SceneId\\": \\"BGFJ7GV\\",\\n \\"GlobalParameterList\\": [\\n {\\n \\"ParamName\\": \\"userName\\",\\n \\"ParamValue\\": \\"lisi\\"\\n }\\n ],\\n \\"Headers\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetPtsScene', 'summary' => 'Queries the structure, stress testing configuration, and other information for a scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsScene'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetPtsSceneBaseLine' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID. For more information, see [Parameters](~~201321~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NB54CV', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'NHG67BF', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Baseline' => [ 'description' => 'The baseline data.', 'type' => 'object', 'properties' => [ 'SceneBaseline' => [ 'description' => 'The baseline data of the scenario.', 'type' => 'object', 'properties' => [ 'FailCountBiz' => ['description' => 'The number of business failures.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'SuccessRateBiz' => ['description' => 'The business success rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], 'AvgRt' => ['description' => 'The average RT.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], 'FailCountReq' => ['description' => 'The number of failed requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'AvgTps' => ['description' => 'The average TPS.', 'type' => 'number', 'format' => 'float', 'example' => '1000', 'title' => ''], 'Seg99Rt' => ['description' => 'The 99th percentile RT.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], 'SuccessRateReq' => ['description' => 'The request success rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], 'Seg90Rt' => ['description' => 'The 90th percentile RT.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'Stress test scenario', 'title' => ''], 'ApiBaselines' => [ 'description' => 'The baseline data of the API.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FailCountBiz' => ['description' => 'The number of business failures.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AvgTps' => ['description' => 'The average transactions per second (TPS).', 'type' => 'number', 'format' => 'float', 'example' => '1000', 'title' => ''], 'MinRt' => ['description' => 'The minimum RT.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'Seg99Rt' => ['description' => 'The 99th percentile RT.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], 'MaxRt' => ['description' => 'The maximum RT.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'Seg90Rt' => ['description' => 'The 90th percentile RT.', 'type' => 'number', 'format' => 'float', 'example' => '40', 'title' => ''], 'SuccessRateBiz' => ['description' => 'The business success rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], 'AvgRt' => ['description' => 'The average response time (RT).', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], 'FailCountReq' => ['description' => 'The number of failed requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Name' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'Order API', 'title' => ''], 'SuccessRateReq' => ['description' => 'The request success rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], 'Id' => ['description' => 'The ID of the API.', 'type' => 'integer', 'format' => 'int64', 'example' => '76543', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The status code of the system.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsSceneBaseLineFail', 'errorMessage' => 'The scene information cannot be empty.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneId\\": \\"NHG67BF\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"Message\\": \\"空\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Baseline\\": {\\n \\"SceneBaseline\\": {\\n \\"FailCountBiz\\": 1000,\\n \\"SuccessRateBiz\\": 0.1,\\n \\"AvgRt\\": 10,\\n \\"FailCountReq\\": 1000,\\n \\"AvgTps\\": 1000,\\n \\"Seg99Rt\\": 10,\\n \\"SuccessRateReq\\": 0.9,\\n \\"Seg90Rt\\": 10\\n },\\n \\"Name\\": \\"Stress test scenario\\",\\n \\"ApiBaselines\\": [\\n {\\n \\"FailCountBiz\\": 100,\\n \\"AvgTps\\": 1000,\\n \\"MinRt\\": 8,\\n \\"Seg99Rt\\": 50,\\n \\"MaxRt\\": 50,\\n \\"Seg90Rt\\": 40,\\n \\"SuccessRateBiz\\": 0.1,\\n \\"AvgRt\\": 10,\\n \\"FailCountReq\\": 100,\\n \\"Name\\": \\"Order API\\",\\n \\"SuccessRateReq\\": 0.9,\\n \\"Id\\": 76543\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'GetPtsSceneBaseLine', 'summary' => 'Queries the baseline data for a scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneBaseLine'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetPtsSceneRunningData' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NKKI6GB', 'title' => ''], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The ID of the task. You can obtain this ID from the response of the StartPtsScene operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'XM6NC5RY', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the scenario. The default value is 7.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'TotalRequestCount' => ['description' => 'The total number of requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '8900', 'title' => ''], 'HasReport' => ['description' => 'Indicates whether a report is generated.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ConcurrencyLimit' => ['description' => 'The concurrency limit.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', 'title' => ''], 'BeginTime' => ['description' => 'The start time of the stress test. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1651895518339', 'title' => ''], 'AgentLocation' => [ 'description' => 'The location of the stress testing agents.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => '华东地区', 'title' => ''], 'Isp' => ['description' => 'The provider.', 'type' => 'string', 'example' => '阿里巴巴', 'title' => ''], 'Count' => ['description' => 'The number of stress testing agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Province' => ['description' => 'The province.', 'type' => 'string', 'example' => '山东省', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Seg90Rt' => ['description' => 'The 90th percentile RT.', 'type' => 'integer', 'format' => 'int64', 'example' => '45', 'title' => ''], 'ResponseBps' => ['description' => 'The size of the response body.', 'type' => 'string', 'example' => '8kb', 'title' => ''], 'TotalAgents' => ['description' => 'The total number of agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '4001', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Vum' => ['description' => 'The number of VUMs consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRt' => ['description' => 'The average response time (RT).', 'type' => 'integer', 'format' => 'int64', 'example' => '45', 'title' => ''], 'ChainMonitorDataList' => [ 'description' => 'The stress testing information for the API.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TimePoint' => ['description' => 'The time point of the data record. This is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1278908899', 'title' => ''], 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => 'ANBDC8B', 'title' => ''], 'MinRt' => ['description' => 'The minimum RT.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'Qps2XX' => ['description' => 'The RPS of successful requests.', 'type' => 'number', 'format' => 'float', 'example' => '78', 'title' => ''], 'MaxRt' => ['description' => 'The maximum RT.', 'type' => 'integer', 'format' => 'int32', 'example' => '56', 'title' => ''], 'ConfigQps' => ['description' => 'The configured RPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '78', 'title' => ''], 'FailedCount' => ['description' => 'The total number of failed requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '456', 'title' => ''], 'FailedQps' => ['description' => 'The RPS of failed requests.', 'type' => 'number', 'format' => 'float', 'example' => '15', 'title' => ''], 'AverageRt' => ['description' => 'The average RT.', 'type' => 'integer', 'format' => 'int32', 'example' => '46', 'title' => ''], 'CheckPointResult' => [ 'description' => 'The checkpoint result.', 'type' => 'object', 'properties' => [ 'SucceedBusinessCount' => ['description' => 'The number of successful business transactions.', 'type' => 'integer', 'format' => 'int64', 'example' => '908', 'title' => ''], 'SucceedBusinessQps' => ['description' => 'The number of successful business RPS.', 'type' => 'number', 'format' => 'float', 'example' => '89', 'title' => ''], 'FailedBusinessCount' => ['description' => 'The number of failed business transactions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'FailedBusinessQps' => ['description' => 'The number of failed business records per second (RPS).', 'type' => 'number', 'format' => 'float', 'example' => '78', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Count2XX' => ['description' => 'The number of successful requests (HTTP 2xx).', 'type' => 'integer', 'format' => 'int64', 'example' => '7890', 'title' => ''], 'RealQps' => ['description' => 'The actual RPS.', 'type' => 'number', 'format' => 'float', 'example' => '23', 'title' => ''], 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'First API', 'title' => ''], 'NodeId' => ['description' => 'The ID of the API.', 'type' => 'integer', 'format' => 'int64', 'example' => '78509', 'title' => ''], 'Concurrency' => ['description' => 'The number of concurrent requests.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestBps' => ['description' => 'The size of the request body.', 'type' => 'string', 'example' => '89kb', 'title' => ''], 'FailedBusinessCount' => ['description' => 'The number of failed business transactions.', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], 'Concurrency' => ['description' => 'The number of concurrent requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'FailedRequestCount' => ['description' => 'The number of failed requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''], 'TpsLimit' => ['description' => 'The configured Transaction Per Second (TPS) limit.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'AliveAgents' => ['description' => 'The number of healthy DPI engines.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalRealQps' => ['description' => 'The total queries per second (QPS).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GetPtsSceneRunningDataFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": 7,\\n \\"TotalRequestCount\\": 8900,\\n \\"HasReport\\": false,\\n \\"ConcurrencyLimit\\": 20,\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"BeginTime\\": 1651895518339,\\n \\"AgentLocation\\": [\\n {\\n \\"Region\\": \\"华东地区\\",\\n \\"Isp\\": \\"阿里巴巴\\",\\n \\"Count\\": 10,\\n \\"Province\\": \\"山东省\\"\\n }\\n ],\\n \\"Seg90Rt\\": 45,\\n \\"ResponseBps\\": \\"8kb\\",\\n \\"TotalAgents\\": 10,\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": true,\\n \\"Vum\\": 100,\\n \\"AverageRt\\": 45,\\n \\"ChainMonitorDataList\\": [\\n {\\n \\"TimePoint\\": 1278908899,\\n \\"ApiId\\": \\"ANBDC8B\\",\\n \\"MinRt\\": 16,\\n \\"Qps2XX\\": 78,\\n \\"MaxRt\\": 56,\\n \\"ConfigQps\\": 78,\\n \\"FailedCount\\": 456,\\n \\"FailedQps\\": 15,\\n \\"AverageRt\\": 46,\\n \\"CheckPointResult\\": {\\n \\"SucceedBusinessCount\\": 908,\\n \\"SucceedBusinessQps\\": 89,\\n \\"FailedBusinessCount\\": 1000,\\n \\"FailedBusinessQps\\": 78\\n },\\n \\"Count2XX\\": 7890,\\n \\"RealQps\\": 23,\\n \\"ApiName\\": \\"First API\\",\\n \\"NodeId\\": 78509,\\n \\"Concurrency\\": 100\\n }\\n ],\\n \\"RequestBps\\": \\"89kb\\",\\n \\"FailedBusinessCount\\": 78,\\n \\"Concurrency\\": 10,\\n \\"HttpStatusCode\\": 400,\\n \\"FailedRequestCount\\": 90,\\n \\"TpsLimit\\": 80,\\n \\"AliveAgents\\": 10,\\n \\"TotalRealQps\\": 10\\n}","type":"json"}]', 'title' => 'GetPtsSceneRunningData', 'summary' => 'Retrieves the runtime data for a scenario during stress testing or debugging.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneRunningData'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetPtsSceneRunningStatus' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario. This is a unique identifier that the system generates after the scenario is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NHBG6V', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the scenario. Valid values:'."\n" ."\n" .'- CREATED'."\n" ."\n" .'- SYNCING'."\n" ."\n" .'- SYNC\\_DONE'."\n" ."\n" .'- UPLOADING'."\n" ."\n" .'- UPLOADED'."\n" ."\n" .'- PREPARING'."\n" ."\n" .'- READY'."\n" ."\n" .'- RUNNING'."\n" ."\n" .'- STOPPING'."\n" ."\n" .'- STOPPED', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the scenario was last modified.', 'type' => 'string', 'example' => '2021-03-26 16:03:56', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'SceneName' => ['description' => 'The name of the scenario.', 'type' => 'string', 'example' => 'Order scenario', 'title' => ''], 'CreateTime' => ['description' => 'The time when the scenario was created.', 'type' => 'string', 'example' => '2021-03-01 16:05:56', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '4001', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'GetPtsSceneRunningStatusFail', 'errorMessage' => 'The scene does not exist', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"RUNNING\\",\\n \\"ModifiedTime\\": \\"2021-03-26 16:03:56\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"Message\\": \\"\\",\\n \\"SceneName\\": \\"Order scenario\\",\\n \\"CreateTime\\": \\"2021-03-01 16:05:56\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'GetPtsSceneRunningStatus', 'summary' => 'Retrieves the runtime status of a scenario after a stress test starts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneRunningStatus'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetUserVpcSecurityGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483646', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp10xjz7c7oqjgasodihj1kx7t', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'SecurityGroupCount' => ['description' => 'The number of security groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], 'SecurityGroupList' => [ 'description' => 'The list of security groups.', 'type' => 'array', 'items' => [ 'description' => 'The details of the security group.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6tar2ohlasdhsatjln37h30bv', 'title' => ''], 'Description' => ['description' => 'The description of the security group.', 'type' => 'string', 'example' => '空', 'title' => ''], 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-bp16bt3zuugxpfjkasdfvthxth8', 'title' => ''], 'SecurityGroupName' => ['description' => 'The name of the security group.', 'type' => 'string', 'example' => 'my-security-group', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '61B15017-1A68-5C47-834F-87E2BBC44F2C', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Code', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], 'title' => 'GetUserVpcSecurityGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecurityGroupCount\\": 9,\\n \\"SecurityGroupList\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf6tar2ohlasdhsatjln37h30bv\\",\\n \\"Description\\": \\"空\\",\\n \\"SecurityGroupId\\": \\"sg-bp16bt3zuugxpfjkasdfvthxth8\\",\\n \\"SecurityGroupName\\": \\"my-security-group\\"\\n }\\n ],\\n \\"RequestId\\": \\"61B15017-1A68-5C47-834F-87E2BBC44F2C\\",\\n \\"Message\\": \\"空\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'summary' => '', ], 'GetUserVpcVSwitch' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483646', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'vpc-2ze22scdz2ebdfjasdfjkqhf4pyj'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'VSwitchCount' => ['description' => 'The number of vSwitches.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '6'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0235E5FC-4C7C-5F0C-843C-FC674F15F947'], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'PageSize' => ['description' => 'The number of records displayed on each page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'PageNumber' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'VSwitchList' => [ 'description' => 'The list of vSwitches.', 'type' => 'array', 'items' => [ 'description' => 'The vSwitch information.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'title' => '', 'example' => 'vpc-wz9bpdaebft6j23fesdf84v2f1um3a'], 'MaxAgentCount' => ['description' => 'The maximum number of pressure-testing agents that can be added.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1000'], 'AvailableIpAddressCount' => ['description' => 'The number of available IP addresses in the vSwitch.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'title' => '', 'example' => 'vsw-bp1eil9df23rsd8l1sevebiszooj'], 'VSwitchName' => ['description' => 'The name of the virtual switch.', 'type' => 'string', 'title' => '', 'example' => 'my-vswitch'], ], 'title' => '', ], 'title' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Code', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], 'title' => 'GetUserVpcVSwitch', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'pts:GetUserVpcVSwitch', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VSwitchCount\\": 6,\\n \\"RequestId\\": \\"0235E5FC-4C7C-5F0C-843C-FC674F15F947\\",\\n \\"Message\\": \\"空\\",\\n \\"PageSize\\": 5,\\n \\"PageNumber\\": 1,\\n \\"VSwitchList\\": [\\n {\\n \\"VpcId\\": \\"vpc-wz9bpdaebft6j23fesdf84v2f1um3a\\",\\n \\"MaxAgentCount\\": 1000,\\n \\"AvailableIpAddressCount\\": 1000,\\n \\"VSwitchId\\": \\"vsw-bp1eil9df23rsd8l1sevebiszooj\\",\\n \\"VSwitchName\\": \\"my-vswitch\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'summary' => '', ], 'GetUserVpcs' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483646', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-2ze22asdfuwiea2ebjkqhf4pyj', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Vpcs' => [ 'description' => 'The list of VPCs.', 'type' => 'array', 'items' => [ 'description' => 'The details of the VPC.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6gc56wdjpafoiwej6adqb4qn72xtw', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'shanghai-vpc', 'title' => ''], 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the VPC.', 'type' => 'string', 'example' => '172.16.80.0/20', 'title' => ''], 'Description' => ['description' => 'The description of the VPC.', 'type' => 'string', 'example' => '空', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the VPC belongs.', 'type' => 'string', 'example' => 'rg-acfm3fzmgkehpewjertna', 'title' => ''], 'VSwitchIds' => [ 'description' => 'The list of vSwitches.', 'type' => 'array', 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1s21fe8r3esdslplvcv5240', 'title' => ''], 'title' => '', 'example' => '', ], 'RouterTableIds' => [ 'description' => 'The list of route table IDs.', 'type' => 'array', 'items' => ['description' => 'The route table ID.', 'type' => 'string', 'example' => 'vtb-bp11tkmteho3svealseipea6h', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEE46204-E1CF-5F48-B094-67362DD4B73F', 'title' => ''], 'Message' => ['description' => 'The error message. This is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'PageSize' => ['description' => 'The number of entries displayed on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Code', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], 'title' => 'GetUserVpcs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"Vpcs\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf6gc56wdjpafoiwej6adqb4qn72xtw\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcName\\": \\"shanghai-vpc\\",\\n \\"CidrBlock\\": \\"172.16.80.0/20\\",\\n \\"Description\\": \\"空\\",\\n \\"ResourceGroupId\\": \\"rg-acfm3fzmgkehpewjertna\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp1s21fe8r3esdslplvcv5240\\"\\n ],\\n \\"RouterTableIds\\": [\\n \\"vtb-bp11tkmteho3svealseipea6h\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"CEE46204-E1CF-5F48-B094-67362DD4B73F\\",\\n \\"Message\\": \\"空\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'summary' => '', ], 'ListEnvs' => [ 'summary' => 'Lists JMeter environments based on specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of environments to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '5', 'example' => '10', 'title' => ''], ], [ 'name' => 'EnvId', 'in' => 'query', 'schema' => ['description' => 'The ID of the environment to query. This is a term query.', 'type' => 'string', 'example' => '10YPA8H', 'title' => '', 'required' => false], ], [ 'name' => 'EnvName', 'in' => 'query', 'schema' => ['description' => 'The keyword in the name of the environment to query. This is a fuzzy query.', 'type' => 'string', 'example' => 'test-create', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The sample response.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of environments that were found.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'PageSize' => ['description' => 'The number of returned environments.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Envs' => [ 'title' => '', 'description' => 'The list of environments.', 'type' => 'array', 'items' => [ 'description' => 'The environment details.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the environment was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637053715165', 'title' => ''], 'RunningScenes' => [ 'title' => '', 'description' => 'The IDs of running scenarios.', 'type' => 'array', 'items' => ['description' => 'The scenario ID details.', 'type' => 'string', 'example' => '[10YPA8H, 0PYP8WH]', 'title' => ''], 'example' => '', ], 'EnvVersion' => ['description' => 'The JMeter version that the environment uses.', 'type' => 'string', 'example' => '5.0', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the environment was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637053719165', 'title' => ''], 'Files' => [ 'title' => '', 'description' => 'The included JAR packages.', 'type' => 'array', 'items' => [ 'description' => 'The file details.', 'type' => 'object', 'properties' => [ 'FileSize' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '788', 'title' => ''], 'Md5' => ['description' => 'The MD5 hash of the JAR package.', 'type' => 'string', 'example' => '43B584026CE5E570F3DE638FA7EEF9E0', 'title' => ''], 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'json.jar', 'title' => ''], 'FileOssAddress' => ['description' => 'The OSS address of the file.', 'type' => 'string', 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', 'title' => ''], 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '61660', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RelatedScenes' => [ 'title' => '', 'description' => 'The associated scenarios.', 'type' => 'array', 'items' => ['description' => 'The details of the associated scenarios.', 'type' => 'string', 'example' => '[10YPA8H, 0PYP8WH]', 'title' => ''], 'example' => '', ], 'UsedCapacity' => ['description' => 'The total size of the environment files.', 'type' => 'integer', 'format' => 'int64', 'example' => '26668', 'title' => ''], 'EnvName' => ['description' => 'The environment name.', 'type' => 'string', 'example' => 'test-create', 'title' => ''], 'EnvId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => '86S1LH', 'title' => ''], 'Properties' => [ 'title' => '', 'description' => 'The JMeter properties.', 'type' => 'array', 'items' => [ 'description' => 'The property details.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'remote_hosts', 'title' => ''], 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Remote host', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 503 => [ ['errorCode' => 'EnvNotExist', 'errorMessage' => 'The env does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Envs\\": [\\n {\\n \\"CreateTime\\": 1637053715165,\\n \\"RunningScenes\\": [\\n \\"[10YPA8H, 0PYP8WH]\\"\\n ],\\n \\"EnvVersion\\": \\"5.0\\",\\n \\"ModifiedTime\\": 1637053719165,\\n \\"Files\\": [\\n {\\n \\"FileSize\\": 788,\\n \\"Md5\\": \\"43B584026CE5E570F3DE638FA7EEF9E0\\",\\n \\"FileName\\": \\"json.jar\\",\\n \\"FileOssAddress\\": \\"https://test.oss-cn-shanghai.aliyuncs.com/json.jar\\",\\n \\"FileId\\": 61660\\n }\\n ],\\n \\"RelatedScenes\\": [\\n \\"[10YPA8H, 0PYP8WH]\\"\\n ],\\n \\"UsedCapacity\\": 26668,\\n \\"EnvName\\": \\"test-create\\",\\n \\"EnvId\\": \\"86S1LH\\",\\n \\"Properties\\": [\\n {\\n \\"Name\\": \\"remote_hosts\\",\\n \\"Value\\": \\"127.0.0.1\\",\\n \\"Description\\": \\"Remote host\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListEnvs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvs'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'ListJMeterReports' => [ 'summary' => 'Queries JMeter reports based on specified conditions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the report page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of reports to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario whose report you want to view.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10YPA8H', 'title' => ''], ], [ 'name' => 'ReportId', 'in' => 'query', 'schema' => ['description' => 'The report ID.', 'type' => 'string', 'example' => '7R4RE352', 'title' => '', 'required' => false], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1637115303000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1637115306000', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The report keyword.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The sample response.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of reports returned based on the condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'Message' => ['description' => 'The returned message. If the request was successful, this parameter is left empty.', 'type' => 'string', 'example' => '空', 'title' => ''], 'PageSize' => ['description' => 'The number of returned reports.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The number of the returned report page. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Reports' => [ 'description' => 'The reports.', 'type' => 'array', 'items' => [ 'description' => 'The report.', 'type' => 'object', 'properties' => [ 'ReportName' => ['description' => 'The report name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Duration' => ['description' => 'The stress testing duration.', 'type' => 'string', 'example' => '10 minutes', 'title' => ''], 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'example' => '7R4RE352', 'title' => ''], 'Vum' => ['description' => 'The consumed Virtual User Minutes (VUM).', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'ActualStartTime' => ['description' => 'The start time of the stress testing.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637157073000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"空\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"HttpStatusCode\\": 200,\\n \\"Reports\\": [\\n {\\n \\"ReportName\\": \\"test\\",\\n \\"Duration\\": \\"10 minutes\\",\\n \\"ReportId\\": \\"7R4RE352\\",\\n \\"Vum\\": 1000,\\n \\"ActualStartTime\\": 1637157073000\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListJMeterReports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJMeterReports'], ], ], 'ramActions' => [], 'translator' => 'manual', ], 'ListOpenJMeterScenes' => [ 'summary' => 'Retrieves a list of JMeter scenarios.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of scenarios to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'example' => 'DYYPZIH', 'title' => ''], ], [ 'name' => 'SceneName', 'in' => 'query', 'schema' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'test', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The sample response.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is left empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'JMeterScene' => [ 'description' => 'The information about the scenarios.', 'type' => 'array', 'items' => [ 'description' => 'The details of a scenario.', 'type' => 'object', 'properties' => [ 'DurationStr' => ['description' => 'The duration of the stress test.', 'type' => 'string', 'example' => '10 minutes', 'title' => ''], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'DYYPZIH', 'title' => ''], 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Status' => ['description' => 'The status of the scenario. Valid values include the following:'."\n" ."\n" .'- PREPARING: The scenario is being prepared.'."\n" ."\n" .'- PREPARED: The scenario is prepared.'."\n" ."\n" .'- STARTING: The scenario is starting.'."\n" ."\n" .'- RUNNING: The scenario is running.'."\n" ."\n" .'- STOPPING: The scenario is stopping.'."\n" ."\n" .'- STOPPED: The scenario is stopped.', 'type' => 'string', 'example' => 'STOPPED', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The status code of the request. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of scenarios returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of scenarios.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"JMeterScene\\": [\\n {\\n \\"DurationStr\\": \\"10 minutes\\",\\n \\"SceneId\\": \\"DYYPZIH\\",\\n \\"SceneName\\": \\"test\\",\\n \\"Status\\": \\"STOPPED\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', 'title' => 'ListOpenJMeterScenes', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOpenJMeterScenes'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'ListPtsReports' => [ 'summary' => 'Lists PTS report summaries that match the specified criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of reports to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'SceneId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the scenario.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1PDAL8H', 'title' => ''], ], [ 'name' => 'ReportId', 'in' => 'formData', 'schema' => ['description' => 'The report ID.', 'type' => 'string', 'example' => '7RLPM3Y2', 'title' => '', 'required' => false], ], [ 'name' => 'BeginTime', 'in' => 'formData', 'schema' => ['description' => 'The start timestamp of the report, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1637115303000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['description' => 'The end timestamp of the report, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1637115306000', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['description' => 'The report keyword.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The sample response.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of reports that match the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E4LR80-15P1-555A-9ZZF-B736AZO5E5ID', 'title' => ''], 'Message' => ['description' => 'The error message. This parameter is an empty string if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'PageSize' => ['description' => 'The number of reports returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'The returned page number. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Reports' => [ 'description' => 'The report information.', 'type' => 'array', 'items' => [ 'description' => 'The report details.', 'type' => 'object', 'properties' => [ 'ReportName' => ['description' => 'The report name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Duration' => ['description' => 'The duration of the stress test.', 'type' => 'string', 'example' => '10 minutes', 'title' => ''], 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'example' => '7RLPM3Y2', 'title' => ''], 'Vum' => ['description' => 'The number of VUMs consumed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'ActualStartTime' => ['description' => 'The timestamp when the stress test started, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637157073000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ReportNotExist', 'errorMessage' => 'The report does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"A8E4LR80-15P1-555A-9ZZF-B736AZO5E5ID\\",\\n \\"Message\\": \\"空\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"HttpStatusCode\\": 200,\\n \\"Reports\\": [\\n {\\n \\"ReportName\\": \\"test\\",\\n \\"Duration\\": \\"10 minutes\\",\\n \\"ReportId\\": \\"7RLPM3Y2\\",\\n \\"Vum\\": 1000,\\n \\"ActualStartTime\\": 1637157073000\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListPtsReports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPtsReports'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'ListPtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'abilityTreeCode' => '22660', 'abilityTreeNodes' => ['FEATUREptsFQKRPS'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value can be from 1 to 1,073,741,824.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of scenarios to display on each page. The value can be from 10 to 1,000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'KeyWord', 'in' => 'query', 'schema' => ['description' => 'The keyword. Use it to perform a fuzzy search by **SceneName** or an exact search by **SceneId**.', 'type' => 'string', 'example' => 'Test order', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '创建或者修改场景入参必须是实体类scene的JSON串', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6F2ED8-E31B-497F-85AB-C4E358A5F667', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'SceneViewList' => [ 'description' => 'The list of queried scenarios.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the scenario was created.', 'type' => 'string', 'example' => '2021-02-26 15:28:39', 'title' => ''], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'DFGVS3S', 'title' => ''], 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'example' => 'Test online ordering', 'title' => ''], 'Status' => ['description' => 'The status of the PTS scenario.', 'type' => 'string', 'example' => 'Running', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'example' => '4001', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ListPtsSceneFail', 'errorMessage' => 'Keyword length cannot exceed 30 characters', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"创建或者修改场景入参必须是实体类scene的JSON串\\",\\n \\"RequestId\\": \\"DD6F2ED8-E31B-497F-85AB-C4E358A5F667\\",\\n \\"HttpStatusCode\\": 400,\\n \\"SceneViewList\\": [\\n {\\n \\"CreateTime\\": \\"2021-02-26 15:28:39\\",\\n \\"SceneId\\": \\"DFGVS3S\\",\\n \\"SceneName\\": \\"Test online ordering\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ],\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'ListPtsScene', 'summary' => 'Queries a paginated list of scenario overviews.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPtsScene'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'ModifyPtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Scene', 'in' => 'formData', 'schema' => ['description' => 'The detailed information about the scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'SD6YZCI'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '449ADAFB-8DA4-4317-A284-4922D04DE828'], 'HttpStatusCode' => ['description' => 'The status code of the request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The status code of the system.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ModifyPtsSceneFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'title' => 'ModifyPtsScene', 'summary' => 'Modifies the configuration of a scenario, such as the URL and stress test settings.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPtsScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:ModifyPtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"449ADAFB-8DA4-4317-A284-4922D04DE828\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'RemoveEnv' => [ 'summary' => 'Removes a JMeter environment using the specified environment ID.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'EnvId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the environment to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 20, 'example' => '10YPA8H'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the call is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the call is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 503 => [ ['errorCode' => 'EnvNotExist', 'errorMessage' => 'The env does not exist.', 'description' => ''], ], ], 'title' => 'RemoveEnv', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveEnv'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:RemoveEnv', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'RemoveOpenJMeterScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the scenario to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'RemoveOpenJMeterScene', 'summary' => 'Removes a JMeter scenario.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveOpenJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:RemoveOpenJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SaveEnv' => [ 'summary' => 'Creates or updates a JMeter environment.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'Env', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The environment.', 'type' => 'object', 'properties' => [ 'EnvId' => ['description' => 'The environment ID. If you do not specify this parameter, a new environment is created. If you specify this parameter, the specified environment is modified.', 'type' => 'string', 'example' => '10YPA8H', 'maxLength' => 20, 'title' => '', 'required' => false], 'EnvName' => ['description' => 'The name of the environment.', 'type' => 'string', 'required' => true, 'example' => 'test-create', 'maxLength' => 50, 'minLength' => 1, 'title' => ''], 'Files' => [ 'title' => '', 'description' => 'The files that the environment depends on.', 'type' => 'array', 'items' => [ 'description' => 'The file details.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name. The file name should be the same as the file name in **FileOssAddress**.', 'type' => 'string', 'required' => true, 'example' => 'json.jar', 'maxLength' => 100, 'minLength' => 1, 'title' => ''], 'FileOssAddress' => ['description' => 'The URL of your file in Object Storage Service (OSS). The file must be accessible over the internet.'."\n" ."\n" .'> Only OSS URLs in the China (Shanghai) region are supported.', 'type' => 'string', 'required' => true, 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', 'maxLength' => 200, 'minLength' => 1, 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 80, 'minItems' => 0, 'example' => '', ], 'Properties' => [ 'title' => '', 'description' => 'The JMeter properties.', 'type' => 'array', 'items' => [ 'description' => 'The property details.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'remote_hosts', 'maxLength' => 1024, 'minLength' => 1, 'title' => '', 'required' => false], 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => '127.0.0.1', 'maxLength' => 1024, 'minLength' => 1, 'title' => '', 'required' => false], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Remote host', 'maxLength' => 1024, 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'JmeterPluginLabel' => ['description' => 'The plugin tag.', 'type' => 'string', 'maxLength' => 32, 'pattern' => '^[A-Z0-9]+$', 'title' => '', 'required' => false, 'example' => 'test'], ], 'required' => true, 'docRequired' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'EnvId' => ['description' => 'The ID of the environment.', 'type' => 'string', 'example' => '10YPA8H', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => '', 'example' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 503 => [ ['errorCode' => 'SaveEnvFail', 'errorMessage' => 'The env cannot be empty.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"EnvId\\": \\"10YPA8H\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'SaveEnv', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveEnv'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'SaveOpenJMeterScene' => [ 'summary' => 'Creates or updates a JMeter scenario.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '104490', 'abilityTreeNodes' => ['FEATUREptsFQKRPS'], ], 'parameters' => [ [ 'name' => 'OpenJMeterScene', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The details of the scenario.', 'type' => 'object', 'properties' => [ 'SceneName' => ['title' => '', 'description' => 'The name of the scenario.', 'type' => 'string', 'required' => true, 'example' => 'test'], 'EnvironmentId' => ['title' => '', 'description' => 'The ID of the associated environment.', 'type' => 'string', 'required' => false, 'example' => 'I8PZIH'], 'JmeterPluginLabel' => ['title' => '', 'description' => 'The label of the JMeter plugin.', 'type' => 'string', 'required' => false, 'maxLength' => 32, 'pattern' => '^[A-Z0-9]+$', 'example' => 'test'], 'TestFile' => ['title' => '', 'description' => 'The test file.', 'type' => 'string', 'required' => true, 'example' => 'baidu.jmx'], 'FileList' => [ 'title' => '', 'description' => 'The list of files.', 'type' => 'array', 'items' => [ 'description' => 'The details of the file.', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'baidu.jmx'], 'FileOssAddress' => ['title' => '', 'description' => 'The public URL of the file in Object Storage Service (OSS).'."\n" ."\n" .'> Currently, only the China (Shanghai) region is supported.', 'type' => 'string', 'required' => true, 'example' => 'https://test.cn-shanghai.aliyuncs.com/baidu.jmx'], 'Md5' => ['title' => '', 'description' => 'The MD5 hash of the file.', 'type' => 'string', 'required' => false, 'example' => 'DA70F97A74D76B6A3BEF9CC8AE0D89EB'], 'FileId' => ['title' => '', 'description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '61232'], 'SplitCsv' => ['title' => '', 'description' => 'Specifies whether to split the file. This parameter is valid only for CSV files.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'FileSize' => ['title' => '', 'description' => 'The file size in bytes. The total size of all files cannot exceed 500 MB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '28880'], 'Tags' => ['title' => '', 'description' => 'The file tags.', 'type' => 'string', 'required' => false, 'example' => '空'], ], 'required' => false, 'title' => '', ], 'required' => true, ], 'JMeterProperties' => [ 'title' => '', 'description' => 'The JMeter properties.', 'type' => 'array', 'items' => [ 'description' => 'The details of the property.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the property.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'https.sessioncontext.shared'], 'Value' => ['description' => 'The value of the property.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'false'], ], 'required' => false, 'title' => '', ], 'required' => false, ], 'RampUp' => ['title' => '', 'description' => 'The ramp-up period, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'], 'Steps' => ['title' => '', 'description' => 'The number of ramp-up steps.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], 'Concurrency' => ['title' => '', 'description' => 'The maximum number of concurrent users. The upper limit is determined by your resource plan. This parameter is required if you set Mode to CONCURRENCY.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], 'Duration' => ['title' => '', 'description' => 'The duration of the stress test, in seconds. The maximum duration is 24 hours. Valid values: 60 to 86400.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '600'], 'SceneId' => ['title' => '', 'description' => 'The scenario ID. If you do not specify this parameter, a new scenario is created. If you specify this parameter, the specified scenario is updated.', 'type' => 'string', 'required' => false, 'example' => 'DYYPZIH'], 'IsVpcTest' => ['title' => '', 'description' => 'Specifies whether to run the stress test in a VPC. The default value is false, which indicates an Internet-based stress test. The VPC-related parameters take effect only if this parameter is set to true.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true'], 'DnsCacheConfig' => [ 'title' => '', 'description' => 'The DNS configuration.', 'type' => 'object', 'properties' => [ 'ClearCacheEachIteration' => ['description' => 'Specifies whether to clear the cache in each loop.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], 'DnsServers' => [ 'description' => 'The DNS servers.', 'type' => 'array', 'items' => ['description' => 'The details of the DNS server.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '[8.8.8.8]'], 'required' => false, 'title' => '', ], 'HostTable' => [ 'description' => 'The host bindings.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['type' => 'string', 'description' => 'The details of the host binding.', 'title' => '', 'example' => '"ns.server.om":"8.8.8.8"'], 'title' => '', ], ], 'required' => false, ], 'AgentCount' => ['title' => '', 'description' => 'The number of agents.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], 'RegionId' => ['title' => '', 'description' => 'The region ID. Configure this parameter for a VPC stress test.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], 'VpcId' => ['title' => '', 'description' => 'The VPC ID. Configure this parameter for a VPC stress test.', 'type' => 'string', 'required' => false, 'example' => 'vpc-2ze2sahjdgahsebjkqhf4pyj'], 'SecurityGroupId' => ['title' => '', 'description' => 'The security group ID. Configure this parameter for a VPC stress test.', 'type' => 'string', 'required' => false, 'example' => 'sg-2zeid0dd7bhahsgdahspaly'], 'VSwitchId' => ['title' => '', 'description' => 'The vSwitch ID. Configure this parameter for a VPC stress test.', 'type' => 'string', 'required' => false, 'example' => 'vsw-2zehsgdhsahw1r'], 'SyncTimerType' => ['title' => '', 'description' => 'The type of the Synchronizing Timer in JMeter.', 'type' => 'string', 'required' => false, 'example' => 'GLOBAL'], 'ConstantThroughputTimerType' => ['title' => 'constantThroughputTimerType', 'description' => 'The type of the Constant Throughput Timer in JMeter.', 'type' => 'string', 'required' => false, 'example' => 'GLOBAL'], 'Mode' => ['title' => '', 'description' => 'The stress testing mode.', 'type' => 'string', 'required' => true, 'example' => 'CONCURRENCY'], 'StartRps' => ['description' => 'The initial RPS. This parameter is valid only in RPS mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], 'MaxRps' => ['description' => 'The maximum number of records per second (RPS). This parameter is valid only in RPS mode.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], 'StartConcurrency' => ['description' => 'The initial number of concurrent users. This parameter is required if you set Mode to CONCURRENCY.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], 'RegionalCondition' => [ 'description' => 'The custom region configuration for agents.', 'type' => 'array', 'items' => [ 'description' => 'The number of agents in a single region.', 'type' => 'object', 'properties' => [ 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], 'Amount' => ['description' => 'The number of agents. The sum of agents across all regions must equal the value of AgentCount for the scenario.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], 'required' => false, 'title' => '', ], 'required' => false, 'title' => '', ], ], 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'SceneId' => ['title' => '', 'description' => 'The ID of the created or updated scenario.', 'type' => 'string', 'example' => 'DYYPZIH'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'Message' => ['description' => 'The error message. This parameter is returned only if the request fails.', 'type' => 'string', 'title' => '', 'example' => '空'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is returned only if the request fails.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The error code. This parameter is returned only if the request fails.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SaveOpenJMeterSceneFail', 'errorMessage' => 'The scene cannot be empty.', 'description' => ''], ], ], 'title' => 'SaveOpenJMeterScene', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveOpenJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'pts:SaveOpenJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneId\\": \\"DYYPZIH\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"空\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SavePtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Scene', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The details of the scenario.', 'type' => 'object', 'properties' => [ 'SceneId' => ['description' => 'The scenario ID. If you do not specify this parameter, a scenario is created. If you specify this parameter, the specified scenario is updated.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'IUYAHGJ'], 'SceneName' => ['description' => 'The scenario name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], 'RelationList' => [ 'title' => '', 'description' => 'The connection configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RelationName' => ['description' => 'The connection name.', 'type' => 'string', 'example' => 'Link 1', 'required' => true, 'title' => ''], 'RelationId' => ['description' => 'The connection ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], 'ApiList' => [ 'title' => '', 'description' => 'The information about the APIs in the connection.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'api'], 'Url' => ['description' => 'The URL for stress testing.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'http://www.example.com'], 'Method' => ['description' => 'The request method.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'GET'], 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], 'ExportList' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExportType' => ['description' => 'The source of the response parameter. Valid values:'."\n" ."\n" .'- BODY\\_TEXT: request body'."\n" ."\n" .'- BODY\\_JSON: request body'."\n" ."\n" .'- HEADER: request header'."\n" ."\n" .'- STATUS\\_CODE: response status code', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'BODY_JSON'], 'ExportName' => ['description' => 'The name of the response parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], 'Count' => ['description' => 'The sequence number of the matching item. The value can be a number or \\`Random\\`. This parameter is required when the response parameter is extracted from the request body (BODY\\_TEXT).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0'], 'ExportValue' => ['description' => 'The expression used to parse the response parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'data.itemlist[0]'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'HeaderList' => [ 'title' => 'headerList', 'description' => 'The request headers.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HeaderName' => ['description' => 'The name of the header field.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Accept-Encoding'], 'HeaderValue' => ['description' => 'The value of the header field.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'gzip, deflate, br'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'CheckPointList' => [ 'title' => '', 'description' => 'The checkpoints.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Operator' => ['description' => 'The checkpoint condition.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ctn'], 'ExpectValue' => ['description' => 'The content to check, which is the expected value.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '111'], 'CheckType' => ['description' => 'The type of the checkpoint. Valid values:'."\n" ."\n" .'- BODY\\_TEXT: response body'."\n" ."\n" .'- HEADER: response header'."\n" ."\n" .'- STATUS\\_CODE: response status code'."\n" ."\n" .'- EXPORTED\\_PARAM: response parameter', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'EXPORTED_PARAM'], 'CheckPoint' => ['description' => 'The object to check.'."\n" ."\n" .'If type is HEADER, this parameter specifies a field in the header. If `type` is `EXPORTED_PARAM`, this parameter specifies the name of a response parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'userId'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'TimeoutInSecond' => ['description' => 'The timeout period for the API call. Unit: seconds. Default value: 5. Valid values: 1 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '5'], 'Body' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ContentType' => ['description' => 'The type of the request body. Default value: `application/x-www-form-urlencoded`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'application/x-www-form-urlencoded'], 'BodyValue' => ['description' => 'The content of the request body. For example, \\`{\\"key1\\":\\"value2\\",\\"key2\\":\\"value2\\"}\\`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{\\"global\\":\\"${global}\\",\\"name\\":\\"${name}\\"}'], ], 'required' => false, 'example' => '', ], 'RedirectCountLimit' => ['description' => 'The number of redirections. Set the value to 0 to allow redirections or 10 to disallow redirections. Configure this parameter as needed.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '0'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'FileParameterExplainList' => [ 'title' => '', 'description' => 'The configurations of the file parameters in the connection.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'fileName.csv'], 'FileParamName' => ['description' => 'The names of the parameter columns in the file.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'name,uid,age'], 'BaseFile' => ['description' => 'Specifies whether the file is a baseline file.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], 'CycleOnce' => ['description' => 'Specifies whether to poll the file once.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'LoadConfig' => [ 'title' => '', 'description' => 'The stress testing configuration.', 'type' => 'object', 'properties' => [ 'TestMode' => ['description' => 'The stress testing mode. Valid values:'."\n" ."\n" .'- concurrency\\_mode: concurrent mode'."\n" ."\n" .'- tps\\_mode: RPS mode', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'concurrency_mode'], 'Configuration' => [ 'title' => '', 'description' => 'The stress testing configuration of the scenario.', 'type' => 'object', 'properties' => [ 'AllRpsBegin' => ['description' => 'The total initial RPS for all APIs.'."\n" ."\n" .'The value is evenly distributed to each API. This parameter is used in RPS mode. If you do not set this parameter, you must set **apiLoadConfig**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], 'AllRpsLimit' => ['description' => 'The total maximum RPS for all APIs.'."\n" ."\n" .'The value is evenly distributed to each API. This parameter is used in RPS mode. If you do not set this parameter, you must set **apiLoadConfig**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], 'AllConcurrencyBegin' => ['description' => 'The total initial number of concurrent users for all connections.'."\n" ."\n" .'The value is evenly distributed to each connection. This parameter is used in concurrent mode. If you do not set this parameter, you must set **relationLoadConfig**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], 'AllConcurrencyLimit' => ['description' => 'The total maximum number of concurrent users for all connections.'."\n" ."\n" .'The value is evenly distributed to each connection. This parameter is used in concurrent mode. If you do not set this parameter, you must set **relationLoadConfig**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], ], 'required' => true, 'example' => '', ], 'MaxRunningTime' => ['description' => 'The duration of the stress test. Unit: minutes. Valid values: 1 to 1440.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '10'], 'AutoStep' => ['description' => 'Specifies whether to enable auto-step. This parameter is valid only in concurrent mode, which is when testMode is set to `concurrency_mode`.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], 'AgentCount' => ['description' => 'The number of agents. This parameter is used when the number of concurrent users is greater than 250 or the number of records per second (RPS) is greater than 2,000. The maximum number of extended agents cannot exceed \\`Maximum number of concurrent users/250\\` or \\`Maximum RPS/2000\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], 'Increment' => ['description' => 'The increment percentage. Valid values: 10 to 100. The value must be a multiple of 10.'."\n" ."\n" .'This parameter is valid only in concurrent mode and when auto-step is enabled. This means testMode is concurrency\\_mode and `autoStep` is `true`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '30'], 'KeepTime' => ['description' => 'The duration of a single stress level. Unit: minutes. The duration must be shorter than the value of **maxRunningTime**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '3'], 'ApiLoadConfigList' => [ 'title' => '', 'description' => 'The initial and maximum RPS for the API. This parameter is used in RPS mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ApiId' => ['title' => 'apiId', 'description' => 'The API ID.', 'type' => 'string', 'required' => true, 'example' => '1'], 'RpsLimit' => ['description' => 'The maximum RPS.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '100'], 'RpsBegin' => ['description' => 'The initial RPS.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '100'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'VpcLoadConfig' => [ 'title' => '', 'description' => 'The VPC configuration.', 'type' => 'object', 'properties' => [ 'VpcId' => ['title' => 'vpcId', 'description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-akjhsdajgjsfggahjkga'], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'vsw-skjfhlahsljkhsfalkjdoiw'], 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sg-jkasgfieiajidsjakjscb'], 'RegionId' => ['title' => 'regionId', 'description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], 'required' => false, 'example' => '', ], 'RelationLoadConfigList' => [ 'title' => '', 'description' => 'The initial and maximum number of concurrent users for the connection. This parameter is used in concurrent mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RelationId' => ['description' => 'The connection ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], 'ConcurrencyLimit' => ['description' => 'The maximum number of concurrent users.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '100'], 'ConcurrencyBegin' => ['title' => 'concurrencyBegin', 'description' => 'The initial number of concurrent users.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], 'AdvanceSetting' => [ 'title' => '', 'description' => 'The advanced settings.', 'type' => 'object', 'properties' => [ 'LogRate' => ['description' => 'The log sampling rate. Valid values: 1 to 50. If the value is greater than 2, it must be a multiple of 10. Valid values: 1, 10, 20, 30, 40, and 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], 'DomainBindingList' => [ 'title' => '', 'description' => 'The mappings between domain names and IP addresses.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'www.example.com'], 'Ips' => [ 'title' => '', 'description' => 'The IP addresses.', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '["192.168.1.1","192.168.1.2"]', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'ConnectionTimeoutInSecond' => ['description' => 'The timeout period. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '5'], 'SuccessCode' => ['description' => 'The custom success status codes. Separate multiple status codes with commas (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '205'], ], 'required' => false, 'example' => '', ], 'GlobalParameterList' => [ 'title' => '', 'description' => 'The global custom parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamName' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'global'], 'ParamValue' => ['description' => 'The value of the global parameter. This value cannot be parameterized.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '11111'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'FileParameterList' => [ 'title' => '', 'description' => 'The file parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test.csv'], 'FileOssAddress' => ['description' => 'The URL of your Object Storage Service (OSS) file. The file must be accessible over the Internet.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'https://jmeter-pts-testing-version.oss-cn-shanghai.aliyuncs.com/param-file.csv'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This message is empty if the request is successful.', 'type' => 'string', 'example' => '空', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SceneId' => ['description' => 'The scenario ID.', 'type' => 'string', 'title' => '', 'example' => 'IUYAHGJ'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ModifyPtsSceneFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"SceneId\\": \\"IUYAHGJ\\"\\n}","type":"json"}]', 'title' => 'SavePtsScene', 'summary' => 'Saves a new scenario or updates an existing one.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SavePtsScene'], ], ], 'ramActions' => [], 'translator' => 'machine', ], 'StartDebugPtsScene' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '22662', 'abilityTreeNodes' => ['FEATUREptsFQKRPS'], ], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NHBGB8B'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C1905194-EE28-4F78-AD81-85A40D52D1BC'], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'PlanId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => ' NJJBH8B'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: successful'."\n" .'- false: failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StartDebugPtsSceneFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'title' => 'StartDebugPtsScene', 'summary' => 'Starts a debug session for a scenario to test its configuration.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDebugPtsScene'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'pts:StartDebugPtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1905194-EE28-4F78-AD81-85A40D52D1BC\\",\\n \\"Message\\": \\"空\\",\\n \\"PlanId\\": \\" NJJBH8B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StartDebuggingJMeterScene' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the scenario to debug.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'ReportId' => ['description' => 'The ID of the report generated from the debugging.', 'type' => 'string', 'title' => '', 'example' => 'MH0SU1I'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'StartDebuggingJMeterScene', 'summary' => 'Starts debugging a JMeter scenario.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDebuggingJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'pts:StartDebuggingJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"ReportId\\": \\"MH0SU1I\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StartPtsScene' => [ 'summary' => 'Starts a scenario based on a specified scenario ID.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '22663', 'abilityTreeNodes' => ['FEATUREptsFQKRPS'], ], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario to start. This ID is returned when you create a scenario and is also displayed on the scenario list page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'FGSRA3'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BD12DCC9-5E48-4E77-9657-8D34D8C0F97B'], 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'PlanId' => ['description' => 'The ID of the stress testing plan. This ID is returned after the scenario is successfully started.', 'type' => 'string', 'title' => '', 'example' => 'SFVAFE'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the operation was successful.'."\n" ."\n" .'- true: The operation was successful.'."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StartPtsSceneFail', 'errorMessage' => 'Scene not exist', 'description' => ''], ], ], 'title' => 'StartPtsScene', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPtsScene'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'pts:StartPtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD12DCC9-5E48-4E77-9657-8D34D8C0F97B\\",\\n \\"Message\\": \\"空\\",\\n \\"PlanId\\": \\"SFVAFE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StartTestingJMeterScene' => [ 'summary' => 'Starts a stress test for a JMeter scenario.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '104515', 'abilityTreeNodes' => ['FEATUREptsB8BARJ'], ], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the scenario to stress test.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'ReportId' => ['description' => 'The report ID.', 'type' => 'string', 'title' => '', 'example' => 'MH0SU1I'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'StartTestingJMeterScene', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartTestingJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'pts:StartTestingJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"ReportId\\": \\"MH0SU1I\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StopDebugPtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'RDDCF7'], ], [ 'name' => 'PlanId', 'in' => 'query', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'FVDC7HB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0AE6505C-55CE-444A-B73B-810D0ED27C66'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StopDebugPtsSceneFail', 'errorMessage' => 'The scene does not exit', 'description' => ''], ], ], 'title' => 'StopDebugPtsScene', 'summary' => 'Stops a scenario that is being debugged.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDebugPtsScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:StopDebugPtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"0AE6505C-55CE-444A-B73B-810D0ED27C66\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StopDebuggingJMeterScene' => [ 'summary' => 'Stops debugging a JMeter scenario.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the scenario to stop debugging.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response example', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This parameter is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The status code of the request. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'StopDebuggingJMeterScene', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDebuggingJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:StopDebuggingJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StopPtsScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the scenario to stop. This ID is returned after you create a scenario. You can also find the ID on the Scenarios page in the PTS console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'GV4DEBG'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The returned message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'DD6F2ED8-E31B-497F-85AB-C4E358A5F6F9'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true'."\n" .'- false', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'StopPtsSceneFail', 'errorMessage' => 'The scene 11434 has no plan', 'description' => ''], ], ], 'title' => 'StopPtsScene', 'summary' => 'Stops a PTS scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPtsScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:StopPtsScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"DD6F2ED8-E31B-497F-85AB-C4E358A5F6F9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'StopTestingJMeterScene' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the stress testing scenario to stop.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DYYPZIH'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response example.', 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This field is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D'], 'HttpStatusCode' => ['description' => 'The HTTP status code. This field is not returned if the request is successful.', 'type' => 'integer', 'format' => 'int32', 'title' => ''], 'Code' => ['description' => 'The system status code. This field is not returned if the request is successful.', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: successful'."\n" .'- false: failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'SceneNotExist', 'errorMessage' => 'The scene does not exist.', 'description' => ''], ], ], 'title' => 'StopTestingJMeterScene', 'summary' => 'Stops a stress test for a JMeter scenario.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopTestingJMeterScene'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:StopTestingJMeterScene', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdatePtsSceneBaseLine' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'SceneId', 'in' => 'query', 'schema' => ['description' => 'The scenario ID. For more information, see [Parameter description](~~201321~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'NB54CV'], ], [ 'name' => 'SceneBaseline', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The baseline data of the scenario. You can pass the toJSONString of the SceneBaseline class from the amazon-pts-api package as the value for this parameter.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{"avgRt":1,"avgTps":1,"failCountBiz":1,"failCountReq":1,"seg90Rt":1,"seg99Rt":2,"successRateBiz":0.5,"successRateReq":1}'], ], [ 'name' => 'ApiBaselines', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The baseline data of the API. You can pass the toJSONString of the list of ApiBaseLine objects from the amazon-pts-api package as the value for this parameter.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '[{"avgRt":1,"avgTps":1,"failCountBiz":1,"failCountReq":182381,"id":362447,"maxRt":3051,"minRt":0,"name":"1-1","seg50Rt":1,"seg75Rt":1,"seg90Rt":1,"seg99Rt":3,"successRateBiz":1,"successRateReq":0,"timingConnAvg":0},{"avgRt":1.06,"avgTps":1,"failCountBiz":0,"failCountReq":151143,"id":362446,"maxRt":3068,"minRt":0,"name":"dd","seg50Rt":1,"seg75Rt":1,"seg90Rt":1,"seg99Rt":2,"successRateBiz":1,"successRateReq":0}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error message. This parameter is empty if the request is successful.', 'type' => 'string', 'title' => '', 'example' => '空'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], 'Code' => ['description' => 'The system status code.', 'type' => 'string', 'title' => '', 'example' => '200'], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- true: successful'."\n" .'- false: failed', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'UpdatePtsSceneBaseLineFail', 'errorMessage' => 'The scene cannot be empty.', 'description' => ''], ], ], 'title' => 'UpdatePtsSceneBaseLine', 'summary' => 'Updates the baseline data for a scenario.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePtsSceneBaseLine'], ], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'pts:UpdatePtsSceneBaseLine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PTS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'pts.aliyuncs.com', 'endpoint' => 'pts.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'EnvNotExist', 'message' => 'The env does not exist.', 'http_code' => 503, 'description' => ''], ['code' => 'Forbidden.NoPermission', 'message' => 'Call method permission denied, please grant permission for current account. https://help.aliyun.com/zh/pts/grant-pts-permissions-to-ram-users-or-roles.', 'http_code' => 403, 'description' => 'No permission to call this interface, please refer to the document for authorization. https://help.aliyun.com/zh/pts/grant-pts-permissions-to-ram-users-or-roles.'], ['code' => 'InvalidParameter', 'message' => 'The input parameter SceneId is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 403, 'description' => 'The specified parameter is invalid.'], ['code' => 'micros.errorcode.invalid.params.not.empty.message', 'message' => 'You must specify the parameter %s.', 'http_code' => 400, 'description' => ''], ['code' => 'ReportNotExist', 'message' => 'The report does not exist.', 'http_code' => 403, 'description' => ''], ['code' => 'SaveEnvFail', 'message' => 'The env cannot be empty.', 'http_code' => 503, 'description' => ''], ['code' => 'SaveOpenJMeterSceneFail', 'message' => 'The scene cannot be empty.', 'http_code' => 403, 'description' => ''], ['code' => 'SceneNotExist', 'message' => 'The scene does not exist.', 'http_code' => 403, 'description' => ''], ['code' => 'Success', 'message' => 'The operation is successful.', 'http_code' => 200, 'description' => 'The operation is successful.'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDebugPtsScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePtsScene'], ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPtsScene'], ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveOpenJMeterScene'], ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveEnv'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneRunningData'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveEnv'], ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetJMeterSceneRunningData'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvs'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SavePtsScene'], ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopTestingJMeterScene'], ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePtsSceneBaseLineFromReport'], ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPtsScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDebugPtsScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsReportsBySceneId'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustPtsSceneSpeed'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsSceneBaseLine'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterSamplingLogs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsDebugSampleLogs'], ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDebuggingJMeterScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneBaseLine'], ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDebuggingJMeterScene'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsReportDetails'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPtsSceneRunningStatus'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePtsSceneBaseLine'], ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartTestingJMeterScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterLogs'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJMeterSampleMetrics'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPtsScene'], ['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOpenJMeterScenes'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllRegions'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePtsScenes'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPtsReports'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPtsScene'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveOpenJMeterScene'], ['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOpenJMeterScene'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJMeterReports'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AdjustJMeterSceneSpeed'], ], ], 'ram' => [ 'productCode' => 'PTS', 'productName' => 'Performance Testing', 'ramCodes' => ['pts'], 'ramLevel' => 'SERVICE', 'ramActions' => [], 'resourceTypes' => [], ], ];