diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/pts/2020-10-20/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/pts/2020-10-20/api-docs.php')
| -rw-r--r-- | data/en_us/pts/2020-10-20/api-docs.php | 9020 |
1 files changed, 9020 insertions, 0 deletions
diff --git a/data/en_us/pts/2020-10-20/api-docs.php b/data/en_us/pts/2020-10-20/api-docs.php new file mode 100644 index 0000000..f720a5c --- /dev/null +++ b/data/en_us/pts/2020-10-20/api-docs.php @@ -0,0 +1,9020 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'PTS', + 'version' => '2020-10-20', + ], + 'directories' => [ + [ + 'id' => 94910, + 'title' => 'PTS Stress Testing', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 94911, + 'title' => 'Stress Testing Baseline', + 'type' => 'directory', + 'children' => [ + 'CreatePtsSceneBaseLineFromReport', + 'DeletePtsSceneBaseLine', + 'UpdatePtsSceneBaseLine', + 'GetPtsSceneBaseLine', + ], + ], + [ + 'id' => 94916, + 'title' => 'Stress Testing Report', + 'type' => 'directory', + 'children' => [ + 'ListPtsReports', + 'GetPtsReportDetails', + 'GetPtsReportsBySceneId', + 'GetPtsDebugSampleLogs', + ], + ], + [ + 'id' => 94919, + 'title' => 'Stress Testing Execution', + 'type' => 'directory', + 'children' => [ + 'StartDebugPtsScene', + 'StartPtsScene', + 'StopDebugPtsScene', + 'StopPtsScene', + 'GetPtsSceneRunningData', + 'GetPtsSceneRunningStatus', + 'AdjustPtsSceneSpeed', + ], + ], + [ + 'id' => 94926, + 'title' => 'Stress Testing Scenario', + 'type' => 'directory', + 'children' => [ + 'CreatePtsScene', + 'SavePtsScene', + 'DeletePtsScene', + 'DeletePtsScenes', + 'ModifyPtsScene', + 'GetPtsScene', + 'ListPtsScene', + ], + ], + ], + ], + [ + 'id' => 94889, + 'title' => 'JMeter Stress Testing', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 94890, + 'title' => 'Stress Testing Report', + 'type' => 'directory', + 'children' => [ + 'GetJMeterReportDetails', + 'GetJMeterLogs', + 'GetJMeterSampleMetrics', + 'GetJMeterSamplingLogs', + 'ListJMeterReports', + ], + ], + [ + 'id' => 94895, + 'title' => 'Stress Testing Execution', + 'type' => 'directory', + 'children' => [ + 'StartDebuggingJMeterScene', + 'StartTestingJMeterScene', + 'StopDebuggingJMeterScene', + 'StopTestingJMeterScene', + 'GetJMeterSceneRunningData', + 'AdjustJMeterSceneSpeed', + ], + ], + [ + 'id' => 94901, + 'title' => 'Stress Testing Scenario', + 'type' => 'directory', + 'children' => [ + 'RemoveOpenJMeterScene', + 'SaveOpenJMeterScene', + 'GetOpenJMeterScene', + 'ListOpenJMeterScenes', + ], + ], + [ + 'id' => 94906, + 'title' => 'Stress Testing Environment', + 'type' => 'directory', + 'children' => [ + 'RemoveEnv', + 'SaveEnv', + 'ListEnvs', + ], + ], + ], + ], + [ + 'id' => 167110, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'GetAllRegions', + 'GetUserVpcs', + 'GetUserVpcSecurityGroup', + 'GetUserVpcVSwitch', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreatePtsSceneBaseLineFromReport' => [ + '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 scene. For more information, see the [table](~~201321~~) provided in this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'VCB78HB', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the report. For more information, see the [table](~~201321~~) provided in this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HNB78HB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'null'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4F7D2CE0-AE4C-4143-954A-8E4595AF86A6', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CreatePtsSceneBaseLineFromReportFail', + 'errorMessage' => 'The scene or the report cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-954A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreatePtsSceneBaseLineFromReportResponse>\\n <Message/>\\n <RequestId>4F7D2CE0-AE4C-4143-954A-8E4595AF86A6</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreatePtsSceneBaseLineFromReportResponse>","errorExample":""}]', + 'title' => 'CreatePtsSceneBaseLineFromReport', + 'summary' => 'null', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePtsSceneBaseLine' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NHGV4CDG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4F7D2XE0-AE4C-4143-955A-8E4595AF86A6', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DeletePtsSceneBaseLineFail', + 'errorMessage' => 'The scene cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2XE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePtsSceneBaseLineResponse>\\n <Message/>\\n <RequestId>4F7D2XE0-AE4C-4143-955A-8E4595AF86A6</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeletePtsSceneBaseLineResponse>","errorExample":""}]', + 'title' => 'DeletePtsSceneBaseLine', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdatePtsSceneBaseLine' => [ + '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 scene. For more information, see the [table](~~201321~~) provided in this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NB54CV', + ], + ], + [ + 'name' => 'SceneBaseline', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'null null'."\n", + 'type' => 'object', + 'required' => false, + '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' => 'null null'."\n", + 'type' => 'object', + 'required' => false, + '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' => 'null'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UpdatePtsSceneBaseLineFail', + 'errorMessage' => 'The scene cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-AE4C-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdatePtsSceneBaseLineResponse>\\n <Message/>\\n <RequestId>4F7D2CE0-AE4C-4143-955A-8E4595AF86A6</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdatePtsSceneBaseLineResponse>","errorExample":""}]', + 'title' => 'UpdatePtsSceneBaseLine', + 'summary' => 'null', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPtsSceneBaseLine' => [ + '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 scene. For more information, see the [table](~~201321~~) provided in this topic.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NB54CV', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => 'The ID of the scene.'."\n", + 'type' => 'string', + 'example' => 'NHG67BF', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6', + ], + 'Message' => [ + 'description' => 'null'."\n", + 'type' => 'string', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Baseline' => [ + 'description' => 'Baseline data'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneBaseline' => [ + 'description' => 'null'."\n", + 'type' => 'object', + 'properties' => [ + 'FailCountBiz' => [ + 'description' => 'null'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'SuccessRateBiz' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'AvgRt' => [ + 'description' => 'Average RT'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'FailCountReq' => [ + 'description' => 'Failures'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'AvgTps' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'Seg99Rt' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'SuccessRateReq' => [ + 'description' => 'request success rate'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'Seg90Rt' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + ], + ], + 'Name' => [ + 'description' => 'Scenario'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ApiBaselines' => [ + 'description' => 'null'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FailCountBiz' => [ + 'description' => 'null'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'AvgTps' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'MinRt' => [ + 'description' => 'null'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Seg99Rt' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '50', + ], + 'MaxRt' => [ + 'description' => 'null'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Seg90Rt' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '40', + ], + 'SuccessRateBiz' => [ + 'description' => 'null'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'AvgRt' => [ + 'description' => 'Average RT'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'FailCountReq' => [ + 'description' => 'Failures'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Name' => [ + 'description' => 'The name of the API operation.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SuccessRateReq' => [ + 'description' => 'request success rate'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'Id' => [ + 'description' => 'The API ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '76543', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsSceneBaseLineFail', + 'errorMessage' => 'The scene information cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"压测场景\\",\\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\\": \\"下单API\\",\\n \\"SuccessRateReq\\": 0.9,\\n \\"Id\\": 76543\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetPtsSceneBaseLineResponse>\\n <SceneId>NHG67BF</SceneId>\\n <RequestId>4F7D2CE0-AE4C-4143-955A-8E4595AF86A6</RequestId>\\n <Message/>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Baseline>\\n <SceneBaseline>\\n <FailCountBiz>1000</FailCountBiz>\\n <SuccessRateBiz>0.1</SuccessRateBiz>\\n <AvgRt>10</AvgRt>\\n <FailCountReq>1000</FailCountReq>\\n <AvgTps>1000</AvgTps>\\n <Seg99Rt>10</Seg99Rt>\\n <SuccessRateReq>0.9</SuccessRateReq>\\n <Seg90Rt>10</Seg90Rt>\\n </SceneBaseline>\\n <Name>压测场景</Name>\\n <ApiBaselines>\\n <FailCountBiz>100</FailCountBiz>\\n <AvgTps>1000</AvgTps>\\n <MinRt>8</MinRt>\\n <Seg99Rt>50</Seg99Rt>\\n <MaxRt>50</MaxRt>\\n <Seg90Rt>40</Seg90Rt>\\n <SuccessRateBiz>0.1</SuccessRateBiz>\\n <AvgRt>10</AvgRt>\\n <FailCountReq>100</FailCountReq>\\n <Name>下单API</Name>\\n <SuccessRateReq>0.9</SuccessRateReq>\\n <Id>76543</Id>\\n </ApiBaselines>\\n </Baseline>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetPtsSceneBaseLineResponse>","errorExample":""}]', + 'title' => 'GetPtsSceneBaseLine', + 'summary' => 'null', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPtsReports' => [ + 'summary' => 'Queries Performance Testing Service (PTS) reports based on specified conditions.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of the page to return. The page number starts from 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of reports to return per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '要查看的报告的场景id', + 'description' => 'The ID of the scenario whose report you want to view.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1PDAL8H', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'formData', + 'schema' => [ + 'title' => '报告ID', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7RLPM3Y2', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '报告的起始时间，单位为ms', + 'description' => 'The timestamp when the stress testing starts. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1637115303000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '报告的结束时间', + 'description' => 'The timestamp when the stress testing ends. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1637115306000', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'title' => '报告关键字', + 'description' => 'The report keyword.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Sample response:'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of reports returned based on the condition.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E4LR80-15P1-555A-9ZZF-B736AZO5E5ID', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of reports returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page. The page number starts from 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Reports' => [ + 'description' => 'The reports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The report.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportName' => [ + 'title' => '报告名称', + 'description' => 'The report name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Duration' => [ + 'title' => '压测持续时间', + 'description' => 'The stress testing duration.'."\n", + 'type' => 'string', + 'example' => '10分钟', + ], + 'ReportId' => [ + 'title' => '报告id', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'example' => '7RLPM3Y2', + ], + 'Vum' => [ + 'title' => '消耗的vum', + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ActualStartTime' => [ + 'title' => '压测开始时间', + 'description' => 'The timestamp when the stress testing starts. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637157073000', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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分钟\\",\\n \\"ReportId\\": \\"7RLPM3Y2\\",\\n \\"Vum\\": 1000,\\n \\"ActualStartTime\\": 1637157073000\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListPtsReportsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message/>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Reports>\\n <ReportName>test</ReportName>\\n <Duration>10分钟</Duration>\\n <ReportId>7R4RE352</ReportId>\\n <Vum>1000</Vum>\\n <ActualStartTime>1637157073000</ActualStartTime>\\n </Reports>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListPtsReportsResponse>","errorExample":""}]', + 'title' => 'ListPtsReports', + ], + '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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'G5HCVS', + ], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the performance testing task. A task ID is generated each time a PTS scenario is started.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'OH5HA3VB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', + ], + 'ReportOverView' => [ + 'description' => 'The summary of the report.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportName' => [ + 'description' => 'The name of the report.'."\n", + 'type' => 'string', + 'example' => 'PTS-TEST', + ], + 'EndTime' => [ + 'description' => 'The end time of the performance testing task.'."\n", + 'type' => 'string', + 'example' => '2024-09-20 10:41:33'."\n", + ], + 'StartTime' => [ + 'description' => 'The start time of the performance testing task.'."\n", + 'type' => 'string', + 'example' => '2024-09-20 10:39:33'."\n", + ], + 'AgentCount' => [ + 'description' => 'The number of load generators. Each load generator has an IP address.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReportId' => [ + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'example' => 'GHB56VD', + ], + 'Vum' => [ + 'description' => 'The virtual user minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1012'."\n", + ], + ], + ], + 'SceneMetrics' => [ + 'description' => 'The metrics of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'FailCountBiz' => [ + 'description' => 'The number of business failures in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AllCount' => [ + 'description' => 'The number of requests in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11872'."\n", + ], + 'SuccessRateBiz' => [ + 'description' => 'The business success rate in the scenario.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgRt' => [ + 'description' => 'The average response time in the scenario.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '170.49'."\n", + ], + 'FailCountReq' => [ + 'description' => 'The number of failed requests in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0'."\n", + ], + 'AvgTps' => [ + 'description' => 'The average transactions per second (TPS) in the scenario.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100.61'."\n", + ], + 'Seg99Rt' => [ + 'description' => 'The 99th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '284'."\n", + ], + 'SuccessRateReq' => [ + 'description' => 'The request success rate in the scenario.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Seg90Rt' => [ + 'description' => 'The 90th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '170'."\n", + ], + ], + ], + 'ApiMetricsList' => [ + 'description' => 'The metrics for API operations in the PTS scenario'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FailCountBiz' => [ + 'description' => 'The number of business-related failures. If a checkpoint is defined, a failure occurs when the conditions for the checkpoint are not satisfied.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Seg75Rt' => [ + 'description' => 'The 75th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '169'."\n", + ], + 'AllCount' => [ + 'description' => 'The total number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11872'."\n", + ], + 'AvgTps' => [ + 'description' => 'The average TPS.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100.61'."\n", + ], + 'MinRt' => [ + 'description' => 'The minimum response time. Unit: ms.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '162'."\n", + ], + 'Seg99Rt' => [ + 'description' => 'The 99th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '284'."\n", + ], + 'Seg50Rt' => [ + 'description' => 'The 50th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '168'."\n", + ], + 'MaxRt' => [ + 'description' => 'The maximum response time. Unit: ms.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '600'."\n", + ], + 'Seg90Rt' => [ + 'description' => 'The 90th percentile response time.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '170'."\n", + ], + 'SuccessRateBiz' => [ + 'description' => 'The business success rate. The value is the ratio of the number of successful business to the total number of business.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'AvgRt' => [ + 'description' => 'The average response time. Unit: ms.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '170.49'."\n", + ], + 'FailCountReq' => [ + 'description' => 'The number of failed requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SuccessRateReq' => [ + 'description' => 'The request success rate. The value is the ratio of the number of successful requests to the total number of requests.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'ApiName' => [ + 'description' => 'The name of the API.'."\n", + 'type' => 'string', + 'example' => 'Test-API'."\n", + ], + ], + 'description' => '', + ], + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.', + 'type' => 'string', + 'example' => '200', + ], + 'SceneSnapShot' => [ + 'description' => 'The snapshot of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the scenario.'."\n", + 'type' => 'string', + 'example' => 'STOPPED', + ], + 'LoadConfig' => [ + 'description' => 'The load settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'ApiLoadConfigList' => [ + 'description' => 'The API request load settings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RpsBegin' => [ + 'description' => 'The starting requests per second (RPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RpsLimit' => [ + 'description' => 'The maximum RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + 'description' => '', + ], + ], + 'MaxRunningTime' => [ + 'description' => 'The maximum running time. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RelationLoadConfigList' => [ + 'description' => 'The settings of the session.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConcurrencyBegin' => [ + 'description' => 'The starting number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ConcurrencyLimit' => [ + 'description' => 'The maximum number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + 'description' => '', + ], + ], + 'Configuration' => [ + 'description' => 'The concurrency and RPS limits in the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'AllRpsBegin' => [ + 'description' => 'The starting RPS in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AllConcurrencyBegin' => [ + 'description' => 'The starting number of concurrent virtual users in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AllConcurrencyLimit' => [ + 'description' => 'The maximum number of concurrent virtual users in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'AllRpsLimit' => [ + 'description' => 'The maximum RPS in the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + ], + ], + 'AgentCount' => [ + 'description' => 'The number of load generators.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TestMode' => [ + 'description' => 'The load application mode.'."\n", + 'type' => 'string', + 'example' => 'TPS', + ], + ], + ], + 'FileParameterList' => [ + 'description' => 'The file used in the scenario.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileOssAddress' => [ + 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", + 'type' => 'string', + 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.csv', + ], + 'FileName' => [ + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'example' => 'test.csv'."\n", + ], + ], + 'description' => '', + ], + ], + 'ModifiedTime' => [ + 'description' => 'The last modification time of the scenario.'."\n", + 'type' => 'string', + 'example' => '2020-10-10 10:10:10', + ], + 'AdvanceSetting' => [ + 'description' => 'The advanced settings of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogRate' => [ + 'description' => 'The log sampling rate.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DomainBindingList' => [ + 'description' => 'The domain name-IP address binding relationships.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'www.example.com'."\n", + ], + 'Ips' => [ + 'description' => 'The IP addresses bound to the domain name.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address bound to the domain name.'."\n", + 'type' => 'string', + 'example' => '[192.168.0.1]'."\n", + ], + ], + ], + 'description' => '', + ], + ], + 'ConnectionTimeoutInSecond' => [ + 'description' => 'The timeout period of the scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SuccessCode' => [ + 'description' => 'The custom success code.'."\n", + 'type' => 'string', + 'example' => '429,404', + ], + ], + ], + 'CreateTime' => [ + 'description' => 'The time when the scenario was created.'."\n", + 'type' => 'string', + 'example' => '2024-09-20 09:28:10'."\n", + ], + 'RelationList' => [ + 'description' => 'The sessions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RelationName' => [ + 'description' => 'The name of the session.'."\n", + 'type' => 'string', + 'example' => 'Test-session-1'."\n", + ], + 'FileParameterExplainList' => [ + 'description' => 'The file parameters used by the session.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleOnce' => [ + 'description' => 'Indicates whether the parameters are used once.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'FileParamName' => [ + 'description' => 'The parameters in the file.'."\n", + 'type' => 'string', + 'example' => 'username', + ], + 'FileName' => [ + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'example' => 'test.csv'."\n", + ], + 'BaseFile' => [ + 'description' => 'Indicates whether the file is used as the baseline file.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + 'ApiList' => [ + 'description' => 'The settings of the API operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'description' => 'The ID of the API operation.'."\n", + 'type' => 'string', + 'example' => 'MNB45', + ], + 'CheckPointList' => [ + 'description' => 'The checkpoints of the API operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckType' => [ + 'description' => 'The check type.'."\n", + 'type' => 'string', + 'example' => 'EXPORTED_PARAM', + ], + 'Operator' => [ + 'description' => 'The check operator.'."\n", + 'type' => 'string', + 'example' => 'ctn', + ], + 'ExpectValue' => [ + 'description' => 'The expected value.'."\n", + 'type' => 'string', + 'example' => '111', + ], + 'CheckPoint' => [ + 'description' => 'The checked item.'."\n", + 'type' => 'string', + 'example' => 'userId', + ], + ], + 'description' => '', + ], + ], + 'HeaderList' => [ + 'description' => 'The headers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderValue' => [ + 'description' => 'The value of the header.'."\n", + 'type' => 'string', + 'example' => 'PTS'."\n", + ], + 'HeaderName' => [ + 'description' => 'The name of the header.'."\n", + 'type' => 'string', + 'example' => 'User-Agent'."\n", + ], + ], + 'description' => '', + ], + ], + 'TimeoutInSecond' => [ + 'description' => 'The timeout period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExportList' => [ + 'description' => 'The export parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExportType' => [ + 'description' => 'The source of the export parameter.'."\n", + 'type' => 'string', + 'example' => 'BODY_JSON', + ], + 'ExportValue' => [ + 'description' => 'The actual path from which you want to extract the export parameter values.'."\n", + 'type' => 'string', + 'example' => 'data.userId', + ], + 'ExportName' => [ + 'description' => 'The name of the export parameter.'."\n", + 'type' => 'string', + 'example' => 'userId', + ], + 'Count' => [ + 'description' => 'The index of the export parameter.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + 'Url' => [ + 'description' => 'The URL to which the API request is sent.'."\n", + 'type' => 'string', + 'example' => 'http://www.example.com/'."\n", + ], + 'Method' => [ + 'description' => 'The method of the request.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + 'Body' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'BodyValue' => [ + 'description' => 'The content of the request body.'."\n", + 'type' => 'string', + 'example' => '{key:value}', + ], + 'ContentType' => [ + 'description' => 'The type of the request body.'."\n", + 'type' => 'string', + 'example' => 'application/x-www-form-urlencoded', + ], + ], + ], + 'RedirectCountLimit' => [ + 'description' => 'The number of redirections.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ApiName' => [ + 'description' => 'The name of the API operation.'."\n", + 'type' => 'string', + 'example' => 'Test-API'."\n", + ], + ], + 'description' => '', + ], + ], + 'RelationId' => [ + 'description' => 'The ID of the session.'."\n", + 'type' => 'string', + 'example' => 'HGBN4D', + ], + ], + 'description' => '', + ], + ], + 'SceneName' => [ + 'description' => 'The name of the scenario.'."\n", + 'type' => 'string', + 'example' => 'PTS-TEST'."\n", + ], + 'SceneId' => [ + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'example' => '7HBNS3', + ], + 'GlobalParameterList' => [ + 'description' => 'The global parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'username', + ], + 'ParamValue' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'user01', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsReportDetailsFail', + 'errorMessage' => 'Report does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<GetPtsReportDetailsResponse>\\n <Message/>\\n <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>\\n <ReportOverView>\\n <ReportName>下单场景</ReportName>\\n <AgentCount>1</AgentCount>\\n <EndTime>1988203944</EndTime>\\n <StartTime>1988202944</StartTime>\\n <ReportId>GHB56VD</ReportId>\\n <Vum>100</Vum>\\n </ReportOverView>\\n <SceneMetrics>\\n <AllCount>100000</AllCount>\\n <SuccessRateBiz>0.97</SuccessRateBiz>\\n <Seg99Rt>56</Seg99Rt>\\n <FailCountBiz>35</FailCountBiz>\\n <SuccessRateReq>0.99</SuccessRateReq>\\n <Seg90Rt>35</Seg90Rt>\\n <FailCountReq>34</FailCountReq>\\n <AvgTps>78</AvgTps>\\n <AvgRt>23</AvgRt>\\n </SceneMetrics>\\n <ApiMetricsList>\\n <Seg50Rt>39</Seg50Rt>\\n <AllCount>1000</AllCount>\\n <SuccessRateBiz>0.98</SuccessRateBiz>\\n <Seg99Rt>35</Seg99Rt>\\n <FailCountBiz>30</FailCountBiz>\\n <Seg75Rt>26</Seg75Rt>\\n <SuccessRateReq>0.99</SuccessRateReq>\\n <MinRt>10</MinRt>\\n <Seg90Rt>23</Seg90Rt>\\n <FailCountReq>40</FailCountReq>\\n <MaxRt>50</MaxRt>\\n <AvgTps>55</AvgTps>\\n <AvgRt>34.5</AvgRt>\\n </ApiMetricsList>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <SceneSnapShot>\\n <Status>STOPPED</Status>\\n <SceneId>7HBNS3</SceneId>\\n <ModifiedTime>2020-10-10 10:10:10</ModifiedTime>\\n <SceneName>下单场景</SceneName>\\n <CreateTime>12684449000</CreateTime>\\n <RelationList>\\n <RelationId>HGBN4D</RelationId>\\n <RelationName>下单链路</RelationName>\\n <ApiList>\\n <ApiName>测试API</ApiName>\\n <RedirectCountLimit>5</RedirectCountLimit>\\n <Method>GET</Method>\\n <TimeoutInSecond>5</TimeoutInSecond>\\n <ApiId>MNB45</ApiId>\\n <Url>https://www.aliyundoc.com</Url>\\n <ExportList>\\n <ExportType>BODY_JSON</ExportType>\\n <ExportName>userId</ExportName>\\n <Count>1</Count>\\n <ExportValue>data.userId</ExportValue>\\n </ExportList>\\n <CheckPointList>\\n <Operator>ctn</Operator>\\n <ExpectValue>111</ExpectValue>\\n <CheckType>EXPORTED_PARAM</CheckType>\\n <CheckPoint>userId</CheckPoint>\\n </CheckPointList>\\n <HeaderList>\\n <HeaderValue>userName</HeaderValue>\\n <HeaderName>1111</HeaderName>\\n </HeaderList>\\n <Body>\\n <ContentType>application/x-www-form-urlencoded</ContentType>\\n <BodyValue>{key:value}</BodyValue>\\n </Body>\\n </ApiList>\\n <FileParameterExplainList>\\n <BaseFile>true</BaseFile>\\n <CycleOnce>true</CycleOnce>\\n <FileParamName>address,name</FileParamName>\\n <FileName>city.csv</FileName>\\n </FileParameterExplainList>\\n </RelationList>\\n <FileParameterList>\\n <FileName>city.csv</FileName>\\n <FileOssAddress>https://www.sss.ccv</FileOssAddress>\\n </FileParameterList>\\n <GlobalParameterList>\\n <ParamValue>lisi</ParamValue>\\n <ParamName>userName</ParamName>\\n </GlobalParameterList>\\n <LoadConfig>\\n <AgentCount>1</AgentCount>\\n <TestMode>tps_mode</TestMode>\\n <MaxRunningTime>2</MaxRunningTime>\\n <ApiLoadConfigList>\\n <RpsLimit>10</RpsLimit>\\n <RpsBegin>10</RpsBegin>\\n </ApiLoadConfigList>\\n <RelationLoadConfigList>\\n <ConcurrencyLimit>20</ConcurrencyLimit>\\n <ConcurrencyBegin>10</ConcurrencyBegin>\\n </RelationLoadConfigList>\\n <Configuration>\\n <AllRpsBegin>80</AllRpsBegin>\\n <AllRpsLimit>160</AllRpsLimit>\\n <AllConcurrencyBegin>10</AllConcurrencyBegin>\\n <AllConcurrencyLimit>10</AllConcurrencyLimit>\\n </Configuration>\\n </LoadConfig>\\n <AdvanceSetting>\\n <LogRate>1</LogRate>\\n <ConnectionTimeoutInSecond>5</ConnectionTimeoutInSecond>\\n <SuccessCode>429,404</SuccessCode>\\n <DomainBindingList>\\n <Domain>www.aliyundoc.com</Domain>\\n <Ips>[1.1.1.1]</Ips>\\n </DomainBindingList>\\n </AdvanceSetting>\\n </SceneSnapShot>\\n <Success>true</Success>\\n</GetPtsReportDetailsResponse>","errorExample":""}]', + 'title' => 'GetPtsReportDetails', + 'summary' => 'Queries the details of a report for a performance testing task in a Performance Testing Service (PTS) scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NGBCD4K', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to display in the paging operation.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of reports to display per page. Valid values: 5 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '5', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ReportOverViewList' => [ + 'description' => 'The reports.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReportName' => [ + 'description' => 'The title of the report.'."\n", + 'type' => 'string', + 'example' => 'PTS-test-20240920094710', + ], + 'EndTime' => [ + 'description' => 'The end time of the stress testing.'."\n", + 'type' => 'string', + 'example' => '2021-02-26 16:38:30', + ], + 'StartTime' => [ + 'description' => 'The start time of the stress testing.'."\n", + 'type' => 'string', + 'example' => '2021-02-26 16:28:30', + ], + 'AgentCount' => [ + 'description' => 'The number of stress testers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReportId' => [ + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'example' => 'NGGB5FV', + ], + 'Vum' => [ + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + 'description' => '', + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsReportsBySceneIdFail', + 'errorMessage' => 'The scene has not started', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<GetPtsReportsBySceneIdResponse>\\n <Message/>\\n <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ReportOverViewList>\\n <ReportName>下单场景</ReportName>\\n <AgentCount>1</AgentCount>\\n <EndTime>2021-02-26 16:38:30</EndTime>\\n <StartTime>2021-02-26 16:28:30</StartTime>\\n <ReportId>NGGB5FV</ReportId>\\n <Vum>100</Vum>\\n </ReportOverViewList>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetPtsReportsBySceneIdResponse>","errorExample":""}]', + 'title' => 'GetPtsReportsBySceneId', + 'summary' => 'Queries all reports of multiple scenarios that are generated during the stress testing in batch.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPtsDebugSampleLogs' => [ + 'summary' => 'Queries the sampling logs for a Performance Testing Service (PTS) debugging task.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the debugging task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => ' NJJBH8B', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'SamplingLogs' => [ + 'title' => 'samplingLogs', + 'description' => 'The sampling logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sampling log.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpRequestMethod' => [ + 'title' => 'httpRequestMethod', + 'description' => 'The request method.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + 'HttpResponseStatus' => [ + 'title' => 'httpResponseStatus', + 'description' => 'The HTTP status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Timestamp' => [ + 'title' => 'timestamp', + 'description' => 'The timestamp. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1650253024471', + ], + 'ExportConfig' => [ + 'title' => 'exportConfig', + 'description' => 'The parameter export configuration.'."\n", + 'type' => 'string', + 'example' => '{\\"skuId\\":\\"{R:json@$.page.list[0].skuId}\\"}', + ], + 'HttpResponseFailMsg' => [ + 'title' => 'httpResponseFailMsg', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'CheckResult' => [ + 'title' => 'checkResult', + 'description' => 'The assertion check result.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'HttpResponseBody' => [ + 'title' => 'httpResponseBody', + 'description' => 'The response body.'."\n", + 'type' => 'string', + 'example' => '{"timestamp":1679903049155,"status":404,"error":"Not Found","message":"No message available","path":"/"}', + ], + 'ChainId' => [ + 'title' => 'chainId', + 'description' => 'The ID of the session.'."\n", + 'type' => 'string', + 'example' => '65354719', + ], + 'HttpRequestHeaders' => [ + 'title' => 'httpRequestHeaders', + 'description' => 'The request headers.'."\n", + 'type' => 'string', + 'example' => '[{"name":"v2","sensitive":false,"value":"1"},{"name":"x-pts-test","sensitive":false,"value":"2"}]', + ], + 'Rt' => [ + 'title' => 'rt', + 'description' => 'The response time. Unit: ms.'."\n", + 'type' => 'string', + 'example' => '230', + ], + 'HttpResponseHeaders' => [ + 'title' => 'httpResponseHeaders', + 'description' => 'The response headers.'."\n", + '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 sent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'ExportContent' => [ + 'title' => 'exportContent', + 'description' => 'The exported parameters.'."\n", + 'type' => 'string', + 'example' => '{"skuId":"1"}', + ], + 'ImportContent' => [ + 'title' => 'importContent', + 'description' => 'The imported parameters.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'HttpTiming' => [ + 'title' => 'httpTiming', + 'description' => 'The HTTP timing information in a waterfall format.'."\n", + '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 body of the request.'."\n", + 'type' => 'string', + 'example' => '{"loginacct":"acce"}', + ], + 'NodeId' => [ + 'title' => 'nodeId', + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => '1345531', + ], + 'HttpRequestUrl' => [ + 'title' => 'httpRequestUrl', + 'description' => 'The endpoint that specifies where the request is directed.'."\n", + 'type' => 'string', + 'example' => 'http://www.example.com', + ], + 'ChainName' => [ + 'description' => 'The name of the session.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsDebugSampleLogsFail', + 'errorMessage' => 'planId not exist', + ], + ], + ], + '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\\": \\"串联链路\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Success\\": true,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetPtsDebugSampleLogs', + ], + '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, + 'example' => 'NHBGB8B', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C1905194-EE28-4F78-AD81-85A40D52D1BC', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PlanId' => [ + 'description' => 'The ID of the stress testing task.'."\n", + 'type' => 'string', + 'example' => ' NJJBH8B', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StartDebugPtsSceneFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C1905194-EE28-4F78-AD81-85A40D52D1BC\\",\\n \\"Message\\": \\"空\\",\\n \\"PlanId\\": \\" NJJBH8B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartDebugPtsSceneResponse>\\n <RequestId>C1905194-EE28-4F78-AD81-85A40D52D1BC</RequestId>\\n <Message/>\\n <PlanId> NJJBH8B</PlanId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StartDebugPtsSceneResponse>","errorExample":""}]', + 'title' => 'StartDebugPtsScene', + 'summary' => 'Starts the debugging of a scenario to check whether the settings of the scenario take effect.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartPtsScene' => [ + 'summary' => 'Starts a scenario by using its 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 that you want to start, which is the ID that is returned after the scenario is created. You can view scenario IDs on the scenario list page.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FGSRA3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'BD12DCC9-5E48-4E77-9657-8D34D8C0F97B', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PlanId' => [ + 'description' => 'The performance testing plan ID. If the scenario is successfully started, this parameter is returned.'."\n", + 'type' => 'string', + 'example' => 'SFVAFE', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StartPtsSceneFail', + 'errorMessage' => 'Scene not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BD12DCC9-5E48-4E77-9657-8D34D8C0F97B\\",\\n \\"Message\\": \\"空\\",\\n \\"PlanId\\": \\"SFVAFE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartPtsSceneResponse>\\n <RequestId>BD12DCC9-5E48-4E77-9657-8D34D8C0F97B</RequestId>\\n <Message/>\\n <PlanId>SFVAFE</PlanId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StartPtsSceneResponse>","errorExample":""}]', + 'title' => 'StartPtsScene', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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, + 'example' => 'RDDCF7', + ], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the stress testing task.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FVDC7HB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0AE6505C-55CE-444A-B73B-810D0ED27C66', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StopDebugPtsSceneFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"0AE6505C-55CE-444A-B73B-810D0ED27C66\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopDebugPtsSceneResponse>\\n <Message/>\\n <RequestId>0AE6505C-55CE-444A-B73B-810D0ED27C66</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StopDebugPtsSceneResponse>","errorExample":""}]', + 'title' => 'StopDebugPtsScene', + 'summary' => 'Stops the scenario that is in debugging.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 that you want to stop, which is the ID that is returned after the scenario is created. You can view scenario IDs on the scenario list page in the PTS console.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'GV4DEBG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DD6F2ED8-E31B-497F-85AB-C4E358A5F6F9', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'StopPtsSceneFail', + 'errorMessage' => 'The scene 11434 has no plan', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"DD6F2ED8-E31B-497F-85AB-C4E358A5F6F9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopPtsSceneResponse>\\n <IsSuccess>true</IsSuccess>\\n <RequestId>DD6F2ED8-E31B-497F-85AB-C4E358A5F6F9</RequestId>\\n <Message/>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StopPtsSceneResponse>","errorExample":""}]', + 'title' => 'StopPtsScene', + 'summary' => 'Stops a scenario by using its ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 scenario ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NKKI6GB', + ], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the stress testing task. You can obtain the task ID by calling the StartPtsScene operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NHBGVF8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The scenario status. The default parameter value is 7.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TotalRequestCount' => [ + 'description' => 'The total number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8900', + ], + 'HasReport' => [ + 'description' => 'Indicates whether a report is generated.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ConcurrencyLimit' => [ + 'description' => 'The maximum concurrency.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'no message', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', + ], + 'BeginTime' => [ + 'description' => 'The start time of the stress testing that is displayed as a timestamp. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651895518339', + ], + 'AgentLocation' => [ + 'description' => 'The location information of stress testers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The region in which the stress tester resides.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Isp' => [ + 'description' => 'The provider of the stress tester.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Count' => [ + 'description' => 'The number of stress testers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Province' => [ + 'description' => 'The province in which the stress tester resides.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + 'description' => '', + ], + ], + 'Seg90Rt' => [ + 'description' => 'The 90th percentile of reaction time (RT).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'ResponseBps' => [ + 'description' => 'The size of the response body.'."\n", + 'type' => 'string', + 'example' => '8kb', + ], + 'TotalAgents' => [ + 'description' => 'The total number of stress testers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Vum' => [ + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'AverageRt' => [ + 'description' => 'The average RT.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'ChainMonitorDataList' => [ + 'description' => 'The stress testing details of the GetPtsSceneRunningData operation.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => 'The point in time at which the stress testing is performed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1278908899', + ], + 'ApiId' => [ + 'description' => 'The API ID.'."\n", + 'type' => 'string', + 'example' => 'ANBDC8B', + ], + 'MinRt' => [ + 'description' => 'The minimum RT.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Qps2XX' => [ + 'description' => 'The Requests Per Second (RPS) of successful requests.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '78', + ], + 'MaxRt' => [ + 'description' => 'The maximum RT.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '56', + ], + 'ConfigQps' => [ + 'description' => 'The RPS of successful and failed requests.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '78', + ], + 'FailedCount' => [ + 'description' => 'The total number of failed requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '456', + ], + 'FailedQps' => [ + 'description' => 'The RPS of failed requests.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '15', + ], + 'AverageRt' => [ + 'description' => 'The average RT.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '46', + ], + 'CheckPointResult' => [ + 'description' => 'The check point results.'."\n", + 'type' => 'object', + 'properties' => [ + 'SucceedBusinessCount' => [ + 'description' => 'The number of successful businesses.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '908', + ], + 'SucceedBusinessQps' => [ + 'description' => 'The RPS of the successful businesses.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '89', + ], + 'FailedBusinessCount' => [ + 'description' => 'The number of failed businesses.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'FailedBusinessQps' => [ + 'description' => 'The RPS of failed businesses.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '78', + ], + ], + ], + 'Count2XX' => [ + 'description' => 'The number of successful requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7890', + ], + 'RealQps' => [ + 'description' => 'The actual RPS.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '23', + ], + 'ApiName' => [ + 'description' => 'The API name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'NodeId' => [ + 'description' => 'The API ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78509', + ], + 'Concurrency' => [ + 'description' => 'The concurrency.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + ], + 'description' => '', + ], + ], + 'RequestBps' => [ + 'description' => 'The size of the request body.'."\n", + 'type' => 'string', + 'example' => '89kb', + ], + 'FailedBusinessCount' => [ + 'description' => 'The total number of failed businesses.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78', + ], + 'Concurrency' => [ + 'description' => 'The total concurrency.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'FailedRequestCount' => [ + 'description' => 'The number of failed requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'TpsLimit' => [ + 'description' => 'The maximum transactions per second (TPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'AliveAgents' => [ + 'description' => 'The number of healthy engines.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalRealQps' => [ + 'description' => 'The total number of queries per second (QPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsSceneRunningDataFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"第一个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}","errorExample":""},{"type":"xml","example":"<GetPtsSceneRunningDataResponse>\\n <Status>6</Status>\\n <HasReport>false</HasReport>\\n <ConcurrencyLimit>20</ConcurrencyLimit>\\n <TotalRequestCount>8900</TotalRequestCount>\\n <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>\\n <Message/>\\n <BeginTime>189009880000</BeginTime>\\n <AgentLocation>\\n <Isp>阿里巴巴</Isp>\\n <Region>华东地区</Region>\\n <Count>10</Count>\\n <Province>山东省</Province>\\n </AgentLocation>\\n <Seg90Rt>45</Seg90Rt>\\n <TotalAgents>10</TotalAgents>\\n <ResponseBps>8kb</ResponseBps>\\n <Code>4001</Code>\\n <Success>true</Success>\\n <Vum>100</Vum>\\n <AverageRt>45</AverageRt>\\n <ChainMonitorDataList>\\n <ApiId>ANBDC8B</ApiId>\\n <ApiName>第一个API</ApiName>\\n <AverageRt>46</AverageRt>\\n <Concurrency>100</Concurrency>\\n <FailedQps>15</FailedQps>\\n <RealQps>23</RealQps>\\n <TimePoint>1278908899</TimePoint>\\n <NodeId>78509</NodeId>\\n <FailedCount>456</FailedCount>\\n <Qps2XX>78</Qps2XX>\\n <MinRt>16</MinRt>\\n <MaxRt>56</MaxRt>\\n <ConfigQps>78</ConfigQps>\\n <Count2XX>7890</Count2XX>\\n <CheckPointResult>\\n <FailedBusinessCount>1000</FailedBusinessCount>\\n <FailedBusinessQps>78</FailedBusinessQps>\\n <SucceedBusinessQps>89</SucceedBusinessQps>\\n <SucceedBusinessCount>908</SucceedBusinessCount>\\n </CheckPointResult>\\n </ChainMonitorDataList>\\n <RequestBps>89kb</RequestBps>\\n <Concurrency>10</Concurrency>\\n <FailedBusinessCount>78</FailedBusinessCount>\\n <HttpStatusCode>400</HttpStatusCode>\\n <FailedRequestCount>90</FailedRequestCount>\\n <TpsLimit>80</TpsLimit>\\n <AliveAgents>10</AliveAgents>\\n</GetPtsSceneRunningDataResponse>","errorExample":""}]', + 'title' => 'GetPtsSceneRunningData', + 'summary' => 'Queries the runtime data of a stress testing or debugging scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NHBG6V', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the scenario. Valid values:'."\n" + ."\n" + .'* CREATED'."\n" + .'* SYNCING'."\n" + .'* SYNC_DONE'."\n" + .'* UPLOADING'."\n" + .'* UPLOADED'."\n" + .'* PREPARING'."\n" + .'* READY'."\n" + .'* RUNNING'."\n" + .'* STOPPING'."\n" + .'* STOPPED'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ModifiedTime' => [ + 'description' => 'The last modification time of the scenario.'."\n", + 'type' => 'string', + 'example' => '2021-03-26 16:03:56', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SceneName' => [ + 'description' => 'The name of the scenario.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'CreateTime' => [ + 'description' => 'The time when the scenario was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-01 16:05:56', + ], + 'HttpStatusCode' => [ + 'description' => 'The request status code. If the operation is successful, this parameter is not returned'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'GetPtsSceneRunningStatusFail', + 'errorMessage' => 'The scene does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"RUNNING\\",\\n \\"ModifiedTime\\": \\"2021-03-26 16:03:56\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"Message\\": \\"\\",\\n \\"SceneName\\": \\"下单场景\\",\\n \\"CreateTime\\": \\"2021-03-01 16:05:56\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<GetPtsSceneRunningStatusResponse>\\n <Status>RUNNING</Status>\\n <ModifiedTime>2021-03-26 16:03:56</ModifiedTime>\\n <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>\\n <Message>创建或者修改场景入参必须是实体类Scene的JSON串</Message>\\n <SceneName>下单场景</SceneName>\\n <CreateTime>2021-03-01 16:05:56</CreateTime>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Code>4001</Code>\\n <Success>false</Success>\\n</GetPtsSceneRunningStatusResponse>","errorExample":""}]', + 'title' => 'GetPtsSceneRunningStatus', + 'summary' => 'Queries the runtime status of a Performance Testing Service (PTS) scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AdjustPtsSceneSpeed' => [ + 'summary' => 'Adjusts the stress in a Performance Testing Service (PTS) scenario.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '报告id', + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYXXX12H', + ], + ], + [ + 'name' => 'ApiSpeedList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The stress testing speed in the PTS scenario.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'description' => 'The API ID. You can find the information of the API corresponding to the ID in the Relation response parameter of the GetPtsSceneRunningData operation based on the ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DYXXX12H', + ], + 'Speed' => [ + 'description' => 'The new stress. In concurrency mode, the new stress is the concurrency. In RPS mode, the new stress is the RPS.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4F7D2CE0-XXXX-4143-955A-8E4595AF86A6', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"4F7D2CE0-XXXX-4143-955A-8E4595AF86A6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AdjustPtsSceneSpeed', + 'description' => 'In concurrency mode, only the concurrency of the first API is passed as that of a session.'."\n" + ."\n" + .'In requests per second (RPS) mode, the RPS of each API can be adjusted. Make sure that the RPS decreases in the API order in the same session.'."\n", + ], + '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 scenario details.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => 'The ID of the created scenario.'."\n", + 'type' => 'string', + 'example' => 'SDR3CX', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4F7D2CE0-AE4C-4143-955A-8E4595AF86A6', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, no data is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CreateSceneFail', + 'errorMessage' => 'Create scene cannot be empty', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<CreatePtsSceneResponse>\\n <SceneId>SDR3CX</SceneId>\\n <RequestId>4F7D2CE0-AE4C-4143-955A-8E4595AF86A6</RequestId>\\n <Message>创建或者修改场景入参必须是实体类Scene的JSON串</Message>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Code>4001</Code>\\n <Success>false</Success>\\n</CreatePtsSceneResponse>","errorExample":""}]', + 'title' => 'CreatePtsScene', + 'summary' => 'Creates a stress testing scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 information about the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'title' => '场景ID，不传为新建，传递为修改', + 'description' => 'The ID of the scenario. To save a new scenario, leave this parameter empty. To update an existing scenario, specify the ID of the scenario.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IUYAHGJ', + ], + 'SceneName' => [ + 'title' => '场景名', + 'description' => 'The name of the scenario.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'RelationList' => [ + 'title' => '链路配置', + 'description' => 'The sessions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RelationName' => [ + 'title' => '链路名', + 'description' => 'The name of the session.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'RelationId' => [ + 'title' => '链路id', + 'description' => 'The ID of the session.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ApiList' => [ + 'title' => '链路下的API信息', + 'description' => 'The API operations on the session.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiName' => [ + 'title' => 'API名', + 'description' => 'The name of the API operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'api', + ], + 'Url' => [ + 'title' => '压测URL', + 'description' => 'The URL to which the API request is sent.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.example.com', + ], + 'Method' => [ + 'title' => '请求方法', + 'description' => 'The request method.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'GET', + ], + 'ApiId' => [ + 'title' => 'API的id', + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ExportList' => [ + 'title' => '出参', + 'description' => 'The export parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExportType' => [ + 'title' => '出参来源 请求体(BODY_TEXT)，请求体(BODY_JSON)，请求头(HEADER)，响应状态码(STATUS_CODE)', + 'description' => 'The source of the export parameter. Valid values:'."\n" + ."\n" + .'* BODY_TEXT: the request body in the BODY_TEXT format'."\n" + .'* BODY_JSON: the request body in the BODY_JSON format.'."\n" + .'* HEADER: the request header'."\n" + .'* STATUS_CODE: the HTTP status code returned by the API'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BODY_JSON', + ], + 'ExportName' => [ + 'title' => '出参名', + 'description' => 'The name of the export parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Count' => [ + 'title' => '第几个匹配项，可以是数字 或 random（ BODY_TEXT情况下才需要count）', + 'description' => 'The index of the matched item. You can specify a number or "Random". If you set ExportType to BODY_TEXT, you must specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'ExportValue' => [ + 'title' => '出参的解析表达式', + 'description' => 'The actual path from which you want to extract the export parameter values.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'data.itemlist[0]', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'HeaderList' => [ + 'title' => 'headerList', + 'description' => 'The headers.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderName' => [ + 'title' => 'header参数名', + 'description' => 'The name of the header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Accept-Encoding', + ], + 'HeaderValue' => [ + 'title' => '参数对应的值', + 'description' => 'The value of the header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gzip, deflate, br', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'CheckPointList' => [ + 'title' => '检查点', + 'description' => 'The checkpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'title' => '检查条件 CheckPointOperator 中', + 'description' => 'The operation or condition that is checked against the expected value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ctn', + ], + 'ExpectValue' => [ + 'title' => '检查内容，即期望值', + 'description' => 'The expected value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '111', + ], + 'CheckType' => [ + 'title' => '检查点类型 响应body(BODY_TEXT)，响应header(HEADER)， 响应状态码(STATUS_CODE) ，出参（EXPORTED_PARAM）', + 'description' => 'The type of check. Valid values:'."\n" + ."\n" + .'* BODY_TEXT: the response body'."\n" + .'* HEADER: the response headers'."\n" + .'* STATUS_CODE: the HTTP status code returned by the API'."\n" + .'* EXPORTED_PARAM: a specific export parameter'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EXPORTED_PARAM', + ], + 'CheckPoint' => [ + 'title' => '检查对象 type=HEADER 时，表示header中的字段，type=EXPORTED_PARAM ，表示出参名', + 'description' => 'The checked item.'."\n" + ."\n" + .'This parameter specifies the fields in the header if you specify `CheckType=HEADER` or the name of the export parameter if you specify `CheckType=EXPORTED_PARAM`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'userId', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'TimeoutInSecond' => [ + 'title' => 'API超时时间，单位秒，默认5s，范围[1-60]', + 'description' => 'The timeout period of the API operation. Unit: seconds. Default: 5. Valid values: 1 to 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'Body' => [ + 'title' => '请求body', + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'ContentType' => [ + 'title' => 'body 类型，默认 application/x-www-form-urlencoded', + 'description' => 'The body type. Default: `application/x-www-form-urlencoded`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'application/x-www-form-urlencoded', + ], + 'BodyValue' => [ + 'title' => 'body 的实际内容 形式 {"key1":"value2","key2":"value2"}', + 'description' => 'The data in the body. For example, {"key1":"value2","key2":"value2"}.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"global\\":\\"${global}\\",\\"name\\":\\"${name}\\"}', + ], + ], + 'required' => false, + ], + 'RedirectCountLimit' => [ + 'title' => '重定向次数，只能是0（允许重定向）或者10（不允许重定向）', + 'description' => 'The number of redirections. The value can be 0, which specifies that redirection is allowed, or 10, which specifies that redirection is not allowed. You can specify a value based on your business requirements.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + ], + 'FileParameterExplainList' => [ + 'title' => '链路中的文件参数配置信息', + 'description' => 'The file parameters of the session.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'fileName.csv', + ], + 'FileParamName' => [ + 'title' => '文件使用的参数列名', + 'description' => 'The parameter names in the file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name,uid,age', + ], + 'BaseFile' => [ + 'title' => '是否作为基准文件', + 'description' => 'Specifies whether the file is used as the baseline file.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'CycleOnce' => [ + 'title' => '文件是否轮询一次', + 'description' => 'Specifies whether the file is used for a single execution of the test.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + ], + 'LoadConfig' => [ + 'title' => '施压配置', + 'description' => 'The load settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'TestMode' => [ + 'title' => '施压模式，并发模式(concurrency_mode) 和RPS模式(tps_mode)', + 'description' => 'The load application mode. Valid values:'."\n" + ."\n" + .'* concurrency_mode: concurrency mode'."\n" + .'* tps_mode: RPS mode.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'concurrency_mode', + ], + 'Configuration' => [ + 'title' => '场景施压量级配置信息', + 'description' => 'The load level settings of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'AllRpsBegin' => [ + 'title' => '所有API的起始RPS总值，均分给每个API，在RPS模式下使用，若不设置该值，则apiLoadConfig必须填写', + 'description' => 'The starting RPS for all APIs.'."\n" + ."\n" + .'The value is evenly distributed among all APIs if you set TestMode to RPS. If you do not specify this parameter, you must specify **apiLoadConfig**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'AllRpsLimit' => [ + 'title' => '所有API的最大RPS总值，均分给每个API，在RPS模式下使用，若不设置该值，则apiLoadConfig必须填写', + 'description' => 'The maximum RPS for all APIs.'."\n" + ."\n" + .'The value is evenly distributed among all APIs if you set TestMode to RPS. If you do not specify this parameter, you must specify **apiLoadConfig**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'AllConcurrencyBegin' => [ + 'title' => '所有链路的起始并发总值，均分给每个链路，在并发模式下使用，若不设置该值，则relationLoadConfig必须填写', + 'description' => 'The starting total number of concurrent virtual users in all sessions.'."\n" + ."\n" + .'The value is evenly distributed among all sessions if you set TestMode to concurrency_mode. If you do not specify this parameter, you must configure **relationLoadConfig**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'AllConcurrencyLimit' => [ + 'title' => '所有链路的最大并发总值，均分给每个链路，在并发模式下使用，若不设置该值，则relationLoadConfig必须填写', + 'description' => 'The maximum total number of concurrent virtual users in all sessions.'."\n" + ."\n" + .'The value is evenly distributed among all sessions if you set TestMode to concurrency_mode. If you do not specify this parameter, you must configure **relationLoadConfig**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => true, + ], + 'MaxRunningTime' => [ + 'title' => '施压时长，单位分钟，[1-1440]', + 'description' => 'The duration of load application. Unit: minutes. Valid values: 1 to 1440.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'AutoStep' => [ + 'title' => '是否自动递增，只有在并发模式下有效，即 testMode=concurrency_mode 时', + 'description' => 'Specifies whether the load is automatically incremented. This parameter takes effect only if you set `TestMode=concurrency_mode`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AgentCount' => [ + 'title' => '指定机器数，并发必须大于250(RPS大于2000)才能使用，最大扩展机器数不能超过 最大并发/250(最大RPS/2000)', + 'description' => 'The number of load generators. If the number of concurrent virtual users exceeds 250 or the RPS exceeds 2,000, you can use multiple load generators. The maximum number of load generators is limited to the total number of concurrent virtual users divided by 250 or the total RPS divided by 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Increment' => [ + 'title' => '递增百分比，取值范围[10,100]，且是整十倍；只有在并发模式且是自动递增模式下有效，即 testMode=concurrency_mode 且 autoStep=true 时', + 'description' => 'The increment percentage. Valid values: 10 to 100, in increments of 10.'."\n" + ."\n" + .'This parameter takes effect only if you set `testMode=concurrency_mode`and `autoStep=true`.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'KeepTime' => [ + 'title' => '单量级持续时长，单位分钟，一定是小于施压时长 maxRunningTime', + 'description' => 'The duration of a specific load level. Unit: minutes. The value must be less than the value of **maxRunningTime**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'ApiLoadConfigList' => [ + 'title' => 'API的起始、最大RPS值设置，在RPS模式下使用', + 'description' => 'The API request load settings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'title' => 'apiId', + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'RpsLimit' => [ + 'title' => '最大RPS值', + 'description' => 'The maximum RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + 'RpsBegin' => [ + 'title' => '起始RPS值', + 'description' => 'The starting RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'VpcLoadConfig' => [ + 'title' => 'VPC配置', + 'description' => 'The VPC settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'vpcId', + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-akjhsdajgjsfggahjkga', + ], + 'VSwitchId' => [ + 'title' => '交换机的Id', + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-skjfhlahsljkhsfalkjdoiw', + ], + 'SecurityGroupId' => [ + 'title' => '安全组的Id', + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'sg-jkasgfieiajidsjakjscb', + ], + 'RegionId' => [ + 'title' => 'regionId', + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + 'required' => false, + ], + 'RelationLoadConfigList' => [ + 'title' => '链路的起始、最大并发值设置，在并发模式下使用', + 'description' => 'The session settings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RelationId' => [ + 'title' => '链路id', + 'description' => 'The ID of the session.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ConcurrencyLimit' => [ + 'title' => '最大并发', + 'description' => 'The maximum number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + 'ConcurrencyBegin' => [ + 'title' => 'concurrencyBegin', + 'description' => 'The starting number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'AdvanceSetting' => [ + 'title' => '高级设置', + 'description' => 'The advanced settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogRate' => [ + 'title' => '日志采样率，[1,50]，且是10的倍数', + 'description' => 'The log sampling rate. Valid values: 1, 10, 20, 30, 40, and 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'DomainBindingList' => [ + 'title' => '域名绑定IP关系', + 'description' => 'The domain name-IP address binding relationships'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '域名', + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'Ips' => [ + 'title' => '对应的IP', + 'description' => 'The IP addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => '["192.168.1.1","192.168.1.2"]', + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'ConnectionTimeoutInSecond' => [ + 'title' => '超时时间，单位秒', + 'description' => 'The timeout period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'SuccessCode' => [ + 'title' => '新增成功状态码，多个用英文逗号隔开', + 'description' => 'The success status code. Separate multiple status codes with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '205', + ], + ], + 'required' => false, + ], + 'GlobalParameterList' => [ + 'title' => '全局自定义参数', + 'description' => 'The global customization parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'title' => '参数名', + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'global', + ], + 'ParamValue' => [ + 'title' => '全局参数值，不可参数化', + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '11111', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'FileParameterList' => [ + 'title' => '文件参数', + 'description' => 'The file parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.csv', + ], + 'FileOssAddress' => [ + 'title' => '文件的oss地址，必须是公网可访问的', + 'description' => 'The OSS URL of the file, which must be accessible over the Internet.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://jmeter-pts-testing-version.oss-cn-shanghai.aliyuncs.com/param-file.csv', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SceneId' => [ + 'title' => '场景ID', + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'example' => 'IUYAHGJ', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ModifyPtsSceneFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"SceneId\\": \\"IUYAHGJ\\"\\n}","errorExample":""},{"type":"xml","example":"<SavePtsSceneResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n <SceneId>IUYAHGJ</SceneId>\\n</SavePtsSceneResponse>","errorExample":""}]', + 'title' => 'SavePtsScene', + 'summary' => 'Saves or modifies a Performance Testing Service (PTS) scenario.', + ], + 'DeletePtsScene' => [ + '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 PTS scenario that you want to delete.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'XANH3H', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A3ED870E-C3BF-44F4-B460-A30785E0256B', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DeletePtsSceneFail', + 'errorMessage' => 'Delete Scene failed, please check the scene ID is correct', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A3ED870E-C3BF-44F4-B460-A30785E0256B\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePtsSceneResponse>\\n <Message>创建或修改场景入参必须是实体类Scene的JSON串</Message>\\n <RequestId>A3ED870E-C3BF-44F4-B460-A30785E0256B</RequestId>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Code>4001</Code>\\n <Success>false</Success>\\n</DeletePtsSceneResponse>","errorExample":""}]', + 'title' => 'DeletePtsScene', + 'summary' => 'Deletes a Performance Testing Service (PTS) scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '["5DG9WQJ","9HG9TYJ"]', + ], + 'required' => true, + 'docRequired' => true, + 'example' => '["XVB4DF","AFG3CV"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '35290A5B-AB50-46BD-81E0-E316F86128C4', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DeletePtsScenesFail', + 'errorMessage' => 'Scene is running', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"35290A5B-AB50-46BD-81E0-E316F86128C4\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePtsScenesResponse>\\n <Message>空</Message>\\n <RequestId>35290A5B-AB50-46BD-81E0-E316F86128C4</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeletePtsScenesResponse>","errorExample":""}]', + 'title' => 'DeletePtsScenes', + 'summary' => 'Deletes multiple scenarios at a time.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyPtsScene' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Scene', + 'in' => 'formData', + 'schema' => [ + 'description' => 'null'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SD6YZCI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'null'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '449ADAFB-8DA4-4317-A284-4922D04DE828', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code that is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ModifyPtsSceneFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"449ADAFB-8DA4-4317-A284-4922D04DE828\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyPtsSceneResponse>\\n <Message>空</Message>\\n <RequestId>449ADAFB-8DA4-4317-A284-4922D04DE828</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyPtsSceneResponse>","errorExample":""}]', + 'title' => 'ModifyPtsScene', + 'summary' => 'null', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPtsScene' => [ + '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.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NKJBSH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, N/A is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DC4E3177-6745-4925-B423-4E89VV34221A', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Scene' => [ + 'description' => 'The structure of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the scenario.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'LoadConfig' => [ + 'description' => 'The load settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'ApiLoadConfigList' => [ + 'description' => 'The API request load settings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RpsBegin' => [ + 'description' => 'The starting requests per second (RPS).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RpsLimit' => [ + 'description' => 'The maximum RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ApiId' => [ + 'description' => 'The API ID. You can track an API by its ID in sessions.'."\n", + 'type' => 'string', + 'example' => 'GBFDCV8', + ], + ], + 'description' => '', + ], + ], + 'MaxRunningTime' => [ + 'description' => 'The maximum duration of load application. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RelationLoadConfigList' => [ + 'description' => 'The session load settings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConcurrencyBegin' => [ + 'description' => 'The starting number of concurrent sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ConcurrencyLimit' => [ + 'description' => 'The maximum number of concurrent sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RelationId' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'example' => 'HNBGS7M', + ], + ], + 'description' => '', + ], + ], + 'Configuration' => [ + 'description' => 'The concurrency and RPS settings of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'AllRpsBegin' => [ + 'description' => 'The starting RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AllConcurrencyBegin' => [ + 'description' => 'The starting number of concurrent sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AllConcurrencyLimit' => [ + 'description' => 'The maximum number of concurrent sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AllRpsLimit' => [ + 'description' => 'The maximum RPS.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'AgentCount' => [ + 'description' => 'The number of load generators.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TestMode' => [ + 'description' => 'The load application mode. Transactions per second (TPS) indicates the RPS mode.'."\n" + ."\n" + .'> The load application mode is CONCURRENCY/TPS.'."\n", + 'type' => 'string', + 'example' => 'TPS', + ], + 'AutoStep' => [ + 'description' => 'Indicates whether the load is automatically incremented.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Increment' => [ + 'description' => 'The increment percentage. The valid values are 10 to 100, in increments of 10. This parameter is returned only if you set testMode to concurrency_mode and set autoStep to true.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'KeepTime' => [ + 'description' => 'The duration during which a specific load level is applied. The duration is less than the value of maxRunningTime. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcLoadConfig' => [ + 'description' => 'The virtual private cloud (VPC) settings. This information is returned only if you set the testing mode to VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-akjhsdajgjsfggahjkga', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-skjfhlahsljkhsfalkjdoiw', + ], + 'SecurityGroupId' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-jkasgfieiajidsjakjscb', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + ], + 'FileParameterList' => [ + 'description' => 'The file parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileOssAddress' => [ + 'description' => 'The OSS address of the file. Make sure that the address is accessible from the Internet.'."\n", + 'type' => 'string', + 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', + ], + 'FileName' => [ + 'description' => 'The file name.'."\n", + 'type' => 'string', + 'example' => 'city.csv', + ], + ], + 'description' => '', + ], + ], + 'ModifiedTime' => [ + 'description' => 'The last modification time of the scenario.'."\n", + 'type' => 'string', + 'example' => '2021-03-26 15:30:30', + ], + 'AdvanceSetting' => [ + 'description' => 'The advanced settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'LogRate' => [ + 'description' => 'The log sampling rate.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DomainBindingList' => [ + 'description' => 'The IP-domain name bindings.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => 'The domain name.'."\n", + 'type' => 'string', + 'example' => 'www.aliyundoc.com', + ], + 'Ips' => [ + 'description' => 'The IPs bound to the domain name.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP bound to the domain name.'."\n", + 'type' => 'string', + 'example' => '[1.1.1.1]', + ], + ], + ], + 'description' => '', + ], + ], + 'ConnectionTimeoutInSecond' => [ + 'description' => 'The timeout period of the scenario. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SuccessCode' => [ + 'description' => 'The custom success code.'."\n", + 'type' => 'string', + 'example' => '429,304', + ], + ], + ], + 'CreateTime' => [ + 'description' => 'The creation time of the scenario.'."\n", + 'type' => 'string', + 'example' => '2021-02-26 15:30:30', + ], + 'RelationList' => [ + 'description' => 'The sessions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RelationName' => [ + 'description' => 'The session name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'FileParameterExplainList' => [ + 'description' => 'The file parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleOnce' => [ + 'description' => 'Indicates whether the parameters are used for a single test execution.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FileParamName' => [ + 'description' => 'The parameter names in the file.'."\n", + 'type' => 'string', + 'example' => 'userName,age', + ], + 'FileName' => [ + 'description' => 'The file name.'."\n", + 'type' => 'string', + 'example' => 'city.csv', + ], + 'BaseFile' => [ + 'description' => 'Indicates whether the file serves as the primary dataset for the test.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + 'ApiList' => [ + 'description' => 'The APIs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'description' => 'The API ID. You can track an API by its ID in sessions.'."\n", + 'type' => 'string', + 'example' => 'GBFDCV8', + ], + 'CheckPointList' => [ + 'description' => 'The checkpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckType' => [ + 'description' => 'The check type.'."\n", + 'type' => 'string', + 'example' => 'EXPORTED_PARAM', + ], + 'Operator' => [ + 'description' => 'The check operator.'."\n", + 'type' => 'string', + 'example' => 'ctn', + ], + 'ExpectValue' => [ + 'description' => 'The expected value.'."\n", + 'type' => 'string', + 'example' => '111', + ], + 'CheckPoint' => [ + 'description' => 'The checked parameter.'."\n", + 'type' => 'string', + 'example' => 'userId', + ], + ], + 'description' => '', + ], + ], + 'HeaderList' => [ + 'description' => 'The headers used in the API request.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderValue' => [ + 'description' => 'The header value.'."\n", + 'type' => 'string', + 'example' => '1111', + ], + 'HeaderName' => [ + 'description' => 'The header name.'."\n", + 'type' => 'string', + 'example' => 'userId', + ], + ], + 'description' => '', + ], + ], + 'TimeoutInSecond' => [ + 'description' => 'The timeout period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExportList' => [ + 'description' => 'The exported parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExportType' => [ + 'description' => 'The format in which data is exported.'."\n", + 'type' => 'string', + 'example' => 'BODY_JSON', + ], + 'ExportValue' => [ + 'description' => 'The parameter that is exported.'."\n", + 'type' => 'string', + 'example' => 'username', + ], + 'ExportName' => [ + 'description' => 'The path where the exported value can be found.'."\n", + 'type' => 'string', + 'example' => 'data.username', + ], + 'Count' => [ + 'description' => 'The number of items or entries related to the export operation.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + 'description' => '', + ], + ], + 'Url' => [ + 'description' => 'The URL to which the request is sent.'."\n", + 'type' => 'string', + 'example' => 'https://www.aliyundoc.com', + ], + 'Method' => [ + 'description' => 'The request method.'."\n", + 'type' => 'string', + 'example' => 'GET', + ], + 'Body' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'BodyValue' => [ + 'description' => 'The body value.'."\n", + 'type' => 'string', + 'example' => '{\\"key1\\":\\"111\\",\\"key2\\":\\"222\\"}', + ], + 'ContentType' => [ + 'description' => 'The body type.'."\n", + 'type' => 'string', + 'example' => 'application/x-www-form-urlencoded', + ], + ], + ], + 'RedirectCountLimit' => [ + 'description' => 'The number of redirections.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ApiName' => [ + 'description' => 'The API name.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + 'description' => '', + ], + ], + 'RelationId' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'example' => 'HNBGS7M', + ], + ], + 'description' => '', + ], + ], + 'SceneName' => [ + 'description' => 'The name of the scenario'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SceneId' => [ + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'example' => 'BGFJ7GV', + ], + 'GlobalParameterList' => [ + 'description' => 'Global parameters'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'userName', + ], + 'ParamValue' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => 'lisi', + ], + ], + 'description' => '', + ], + ], + 'Headers' => [ + 'description' => 'The global headers for the scenario.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the header.'."\n", + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The value of the header.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GetPtsSceneFail', + 'errorMessage' => 'The scene does not exit', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"空\\",\\n \\"RequestId\\": \\"DC4E3177-6745-4925-B423-4E89VV34221A\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Scene\\": {\\n \\"Status\\": \\"Draft：草稿\\\\nWaitStart：待启动\\\\nDebugging：调试中\\\\nRunning：运行中\\\\n\\",\\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\\": \\"下单链路\\",\\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\\": \\"下单\\"\\n }\\n ],\\n \\"RelationId\\": \\"HNBGS7M\\"\\n }\\n ],\\n \\"SceneName\\": \\"下单场景\\",\\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}","errorExample":""},{"type":"xml","example":"<GetPtsSceneResponse>\\n <Message>空</Message>\\n <RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Scene>\\n <Status>Running</Status>\\n <LoadConfig>\\n <ApiLoadConfigList>\\n <RpsBegin>10</RpsBegin>\\n <RpsLimit>20</RpsLimit>\\n <ApiId>GBFDCV8</ApiId>\\n </ApiLoadConfigList>\\n <MaxRunningTime>2</MaxRunningTime>\\n <RelationLoadConfigList>\\n <ConcurrencyBegin>10</ConcurrencyBegin>\\n <ConcurrencyLimit>20</ConcurrencyLimit>\\n <RelationId>HNBGS7M</RelationId>\\n </RelationLoadConfigList>\\n <Configuration>\\n <AllRpsBegin>100</AllRpsBegin>\\n <AllConcurrencyBegin>100</AllConcurrencyBegin>\\n <AllConcurrencyLimit>200</AllConcurrencyLimit>\\n <AllRpsLimit>200</AllRpsLimit>\\n </Configuration>\\n <AgentCount>1</AgentCount>\\n <TestMode>TPS</TestMode>\\n </LoadConfig>\\n <FileParameterList>\\n <FileOssAddress>https://oss.ccccc</FileOssAddress>\\n <FileName>city.csv</FileName>\\n </FileParameterList>\\n <ModifiedTime>2021-03-26 15:30:30</ModifiedTime>\\n <AdvanceSetting>\\n <LogRate>1</LogRate>\\n <DomainBindingList>\\n <Domain>www.aliyundoc.com</Domain>\\n <Ips>[1.1.1.1]</Ips>\\n </DomainBindingList>\\n <ConnectionTimeoutInSecond>5</ConnectionTimeoutInSecond>\\n <SuccessCode>429,304</SuccessCode>\\n </AdvanceSetting>\\n <CreateTime>2021-02-26 15:30:30</CreateTime>\\n <RelationList>\\n <RelationName>下单链路</RelationName>\\n <FileParameterExplainList>\\n <CycleOnce>true</CycleOnce>\\n <FileParamName>userName,age</FileParamName>\\n <FileName>city.csv</FileName>\\n <BaseFile>true</BaseFile>\\n </FileParameterExplainList>\\n <ApiList>\\n <ApiId>GBFDCV8</ApiId>\\n <CheckPointList>\\n <CheckType>EXPORTED_PARAM</CheckType>\\n <Operator>ctn</Operator>\\n <ExpectValue>111</ExpectValue>\\n <CheckPoint>userId</CheckPoint>\\n </CheckPointList>\\n <HeaderList>\\n <HeaderValue>1111</HeaderValue>\\n <HeaderName>userId</HeaderName>\\n </HeaderList>\\n <TimeoutInSecond>5</TimeoutInSecond>\\n <ExportList>\\n <ExportType>BODY_JSON</ExportType>\\n <ExportValue>username</ExportValue>\\n <ExportName>data.username</ExportName>\\n <Count>0</Count>\\n </ExportList>\\n <Url>https://www.aliyundoc.com</Url>\\n <Method>GET</Method>\\n <Body>\\n <BodyValue>{\\\\\\"key1\\\\\\":\\\\\\"111\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"222\\\\\\"}</BodyValue>\\n <ContentType>application/x-www-form-urlencoded</ContentType>\\n </Body>\\n <RedirectCountLimit>5</RedirectCountLimit>\\n <ApiName>下单</ApiName>\\n </ApiList>\\n <RelationId>HNBGS7M</RelationId>\\n </RelationList>\\n <SceneName>下单场景</SceneName>\\n <SceneId>BGFJ7GV</SceneId>\\n <GlobalParameterList>\\n <ParamName>userName</ParamName>\\n <ParamValue>lisi</ParamValue>\\n </GlobalParameterList>\\n </Scene>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetPtsSceneResponse>","errorExample":""}]', + 'title' => 'GetPtsScene', + 'summary' => 'Queries the structure and load settings of a Performance Testing Service (PTS) scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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 number of the page to return. Valid values: 1 to 1073741824.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of scenario entries to return per page. Valid values: 10 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword based on which you can search for the PTS scenario. You can perform a fuzzy search on the scenario name (**SceneName**) or an exact search on the scenario ID (**SceneId**).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DD6F2ED8-E31B-497F-85AB-C4E358A5F667', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, no data is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'SceneViewList' => [ + 'description' => 'The returned scenarios.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'The time when the PTS scenario was created.'."\n", + 'type' => 'string', + 'example' => '2021-02-26 15:28:39', + ], + 'SceneId' => [ + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'example' => 'DFGVS3S', + ], + 'SceneName' => [ + 'description' => 'The scenario name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'description' => 'The status of the PTS scenario. Valid values:'."\n", + 'type' => 'string', + 'example' => 'Draft WaitStart Debugging Running'."\n", + ], + ], + 'description' => '', + ], + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ListPtsSceneFail', + 'errorMessage' => 'Keyword length cannot exceed 30 characters', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"测试下单线上\\",\\n \\"Status\\": \\"Draft：草稿\\\\nWaitStart：待启动\\\\nDebugging：调试中\\\\nRunning：运行中\\\\n\\"\\n }\\n ],\\n \\"Code\\": \\"4001\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<ListJMeterReportsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Reports>\\n <ReportName>test</ReportName>\\n <Duration>10分钟</Duration>\\n <ReportId>7R4RE352</ReportId>\\n <Vum>1000</Vum>\\n <ActualStartTime>1637157073000</ActualStartTime>\\n </Reports>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListJMeterReportsResponse>","errorExample":""}]', + 'title' => 'ListPtsScene', + 'summary' => 'Queries Performance Testing Service (PTS) scenarios by page.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'KS2YE3J2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetJMeterReportDetailsResponse', + 'description' => 'GetJMeterReportDetailsResponse'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportOverView' => [ + 'title' => '报告概览信息', + 'description' => 'The details of the report.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportId' => [ + 'title' => '报告ID', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'example' => 'GHB56VD', + ], + 'ReportName' => [ + 'title' => '报告名', + 'description' => 'The report name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'StartTime' => [ + 'title' => '启动时间', + 'description' => 'The beginning of the queried time range.'."\n", + 'type' => 'string', + 'example' => '2023-05-03 10:35:11', + ], + 'EndTime' => [ + 'title' => '停止时间', + 'description' => 'The end of the queried time range.'."\n", + 'type' => 'string', + 'example' => '2023-05-03 10:45:11', + ], + 'AgentCount' => [ + 'title' => '实际使用的引擎数', + 'description' => 'The number of used engines.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Vum' => [ + 'title' => '消耗的VUM', + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4452', + ], + ], + ], + 'SceneMetrics' => [ + 'title' => '全场景维度的信息', + 'description' => 'The dimensions of the whole scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'AvgTps' => [ + 'title' => '平均TPS', + 'description' => 'The average transactions per second (TPS).'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '78', + ], + 'AvgRt' => [ + 'title' => '平均RT', + 'description' => 'The average response time (RT). Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '23', + ], + 'Seg90Rt' => [ + 'title' => '90分为RT', + 'description' => 'The 90th percentile of RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '35', + ], + 'Seg99Rt' => [ + 'title' => '99分为RT', + 'description' => 'The 99th percentile of RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '56', + ], + 'SuccessRateReq' => [ + 'title' => '请求成功率', + 'description' => 'The request success rate. The parameter value must be a non-negative number less than or equal to 100.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.99', + ], + 'FailCountReq' => [ + 'title' => '请求失败数', + 'description' => 'The request failure rate.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'AllCount' => [ + 'title' => '请求总数', + 'description' => 'The total number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '717', + ], + ], + ], + 'SamplerMetricsList' => [ + 'title' => 'API维度的信息', + 'description' => 'The dimensions of APIs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dimensions of the API. An API has only one entry.'."\n", + 'type' => 'object', + 'properties' => [ + 'ApiName' => [ + 'title' => 'api名', + 'description' => 'The API name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'AvgTps' => [ + 'title' => '平均TPS', + 'description' => 'The average TPS.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '12', + ], + 'AvgRt' => [ + 'title' => '平均RT', + 'description' => 'The average RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '44.2', + ], + 'Seg75Rt' => [ + 'title' => '75分为RT', + 'description' => 'The 75th percentile of RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '22.4', + ], + 'Seg90Rt' => [ + 'title' => '90分为RT', + 'description' => 'The 90th percentile of RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '65', + ], + 'Seg99Rt' => [ + 'title' => '99分为RT', + 'description' => 'The 99th percentile of RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '77', + ], + 'MaxRt' => [ + 'title' => '最大RT', + 'description' => 'The maximum RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '78', + ], + 'MinRt' => [ + 'title' => '最小RT', + 'description' => 'The minimum RT. Unit: milliseconds.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '11', + ], + 'SuccessRateReq' => [ + 'title' => '请求成功率', + 'description' => 'The request success rate. The parameter value must be a non-negative number less than or equal to 100.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + 'FailCountReq' => [ + 'title' => '请求失败数', + 'description' => 'The request failure rate.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AllCount' => [ + 'title' => '请求总数', + 'description' => 'The total number of requests.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '731', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '4001', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DocumentUrl' => [ + 'description' => 'The URL used to access the document.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'CodeKey' => [ + 'title' => '对应于美杜莎的key。若无此codeKey，或者codeKey对应的内容获取失败/空,则获取返回的message内容作为默认信息展示', + '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.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DynamicCtx' => [ + 'title' => '返回的信息,动态内容,用于替换动态内容,通过&&进行分隔,顺序替换', + 'description' => 'The returned dynamic contents that are separated by the && operator.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportOverView\\": {\\n \\"ReportId\\": \\"GHB56VD\\",\\n \\"ReportName\\": \\"下单场景-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\\": \\"登录\\",\\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\\": \\"查询报告失败\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"DocumentUrl\\": \\"空\\",\\n \\"CodeKey\\": \\"空\\",\\n \\"DynamicCtx\\": \\"空\\"\\n}","type":"json"}]', + 'title' => 'GetJMeterReportDetails', + ], + 'GetJMeterLogs' => [ + 'summary' => 'Queries the operational logs of JMeter stress testers. By default, the operational logs of the stress tester identified as number 0 are queried and the total number of stress testers is returned.', + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'exclusiveMaximum' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The number of entries to return per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'title' => '报告ID', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'KS2YE3J2', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1637115306000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1637115309000', + ], + ], + [ + 'name' => 'AgentIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '第几台引擎，起始为0', + 'description' => 'Specifies that the operational logs of the stress tester identified as number 0 are returned if the agent index is invalid.'."\n", + '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 (default)'."\n" + .'* DEBUG'."\n" + .'* TRACE'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INFO', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'title' => '线程名', + 'description' => 'The thread name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'main', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '关键字', + 'description' => 'The keyword.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Logs' => [ + 'title' => '日志内容', + 'description' => 'The returned entries.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned entry.'."\n", + 'type' => 'object', + 'example' => '[{"timeTS":1637308493226, "instanceId":0, "level":"INFO", "logger":"org.apache.jmeter.util.JMeterUtils", "thread":"main", "time":"2021-11-19T15:54Z", "logText":"Setting Locale to en_EN"}]', + ], + '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 system status code. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AgentCount' => [ + 'title' => '引擎数量，想要获得第几台引擎的日志可以根据引擎数量传值', + 'description' => 'The number of engines. The AgentCount value must be greater than the PageNumber value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<GetJMeterLogsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Logs/>\\n <Code>200</Code>\\n <Success>true</Success>\\n <AgentCount>3</AgentCount>\\n</GetJMeterLogsResponse>","errorExample":""}]', + 'title' => 'GetJMeterLogs', + ], + 'GetJMeterSampleMetrics' => [ + 'summary' => 'Queries the metrics of 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' => '报告ID', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7R4RE352', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1637157070000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1637157073000', + ], + ], + [ + 'name' => 'SamplerId', + 'in' => 'query', + 'schema' => [ + 'title' => '采样器索引，从0开始。-1返回全场景', + 'description' => 'The sampler ID. This parameter value starts from 0. If this parameter value is -1, the data of the whole scenario is returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SampleMetricList' => [ + 'title' => '采样器聚合数据列表', + 'description' => 'The metrics of the samplers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metrics of the samplers.'."\n", + 'type' => 'string', + '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 sampler list. You can find the sampler to be queried based on this list.'."\n", + 'type' => 'object', + 'example' => '{0:"Http Request"}', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<GetJMeterSampleMetricsResponse>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <SampleMetricList>[{ \\"statusCodes\\":Array[1], \\"requestBytes\\":1001638, \\"reqFailureCount\\":0, \\"bucket\\":\\"e29e69b15e584bef\\", \\"reqFailureTps\\":0, \\"nodeId\\":0, \\"rtMax\\":698, \\"reqFailureRtMin\\":0, \\"reqSuccessTps\\":4132.800798801797, \\"rtAvg\\":55, \\"totalCount\\":8278, \\"rtMin\\":29, \\"reqFailureRtMax\\":0, \\"timestamp\\":1637308496000, \\"requestBps\\":500069, \\"reqSuccessCount\\":8278, \\"reqSuccessRtAvg\\":55, \\"reqSuccessRtMin\\":29, \\"responseBytes\\":20670166, \\"tps\\":4132.800798801797, \\"responseBps\\":10319604, \\"reqSuccessRtMax\\":698, \\"taskId\\":1214920 }]</SampleMetricList>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetJMeterSampleMetricsResponse>","errorExample":""}]', + 'title' => 'GetJMeterSampleMetrics', + ], + 'GetJMeterSamplingLogs' => [ + 'summary' => 'Queries the sampling logs of a JMeter sampler.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1637157073000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1637157076000', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'title' => '报告ID', + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7R4RE352', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'title' => '压测引擎编号', + 'description' => 'The ID of the load generator. This parameter is disabled.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14238000', + ], + ], + [ + 'name' => 'SamplerId', + 'in' => 'query', + 'schema' => [ + 'title' => '第几个采样器，从0开始', + 'description' => 'The ID of the sampler. The value starts from 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Success', + 'in' => 'query', + 'schema' => [ + 'title' => '采样结果是否成功', + 'description' => 'Specifies whether the sampling is successful.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'title' => '线程', + 'description' => 'The name of the thread. Fuzzy searching is supported. If you specify multiple threads, separate the threads with spaces.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'main', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '关键字', + 'description' => 'The keyword. You can use the keyword in the value of **SceneName** for fuzzy searching or use the value of **SceneID** for exact searching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'MinRT', + 'in' => 'query', + 'schema' => [ + 'title' => '最小响应时间，单位ms', + 'description' => 'The minimum response time. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'MaxRT', + 'in' => 'query', + 'schema' => [ + 'title' => '最大响应时间，单位ms', + 'description' => 'The maximum response time. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'ResponseCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of log entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of log entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'SampleResults' => [ + 'title' => '采样器的采样结果', + 'description' => 'The sampling results of the sampler.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The sampling result.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<GetJMeterSamplingLogsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <HttpStatusCode>200</HttpStatusCode>\\n <SampleResults>{endTimeTS=1637308494609, dataEncoding=utf-8, latency=35, samplerData=GET http://www.baidu.com/, httpMethod=GET, idleTime=0, responseCode=200, responseDataAsString=你就知道, startTimeTS=1637308494574, requestByteCount=121, samplerId=0, connectTime=19, sceneId=252136, startTime=2021-11-19T15:54Z, planId=1505314, requestData=, contentType=text/html, responseDataTruncated=false, dataType=text, samplerLabel=HTTP Request, mediaType=text/html, url=http://www.baidu.com/, threadName=Thread Group 1-1, responseHeaders=HTTP/1.1 200 OK, requestHeaders=Connection: keep-alive Host: www.baidu.com User-Agent: Apache-HttpClient/4.5.6 (Java/11.0.7.7-AJDK) , success=true, bodySize=2381}</SampleResults>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetJMeterSamplingLogsResponse>","errorExample":""}]', + 'title' => 'GetJMeterSamplingLogs', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of reports to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '要查看的报告的场景id', + 'description' => 'The ID of the scenario whose report you want to view.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '10YPA8H', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'title' => '报告ID', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7R4RE352', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'title' => '报告的起始时间，单位为ms', + 'description' => 'The beginning of the time range to query. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1637115303000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '报告的结束时间', + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1637115306000', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '报告关键字', + 'description' => 'The report keyword.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of reports returned based on the condition.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of returned reports.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned report page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Reports' => [ + 'description' => 'The reports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The report.'."\n", + 'type' => 'object', + 'properties' => [ + 'ReportName' => [ + 'title' => '报告名称', + 'description' => 'The report name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Duration' => [ + 'title' => '压测持续时间', + 'description' => 'The stress testing duration.'."\n", + 'type' => 'string', + 'example' => '10分钟', + ], + 'ReportId' => [ + 'title' => '报告id', + 'description' => 'The report ID.'."\n", + 'type' => 'string', + 'example' => '7R4RE352', + ], + 'Vum' => [ + 'title' => '消耗的vum', + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ActualStartTime' => [ + 'title' => '压测开始时间', + 'description' => 'The start time of the stress testing.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637157073000', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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分钟\\",\\n \\"ReportId\\": \\"7R4RE352\\",\\n \\"Vum\\": 1000,\\n \\"ActualStartTime\\": 1637157073000\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListJMeterReportsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Reports>\\n <ReportName>test</ReportName>\\n <Duration>10分钟</Duration>\\n <ReportId>7R4RE352</ReportId>\\n <Vum>1000</Vum>\\n <ActualStartTime>1637157073000</ActualStartTime>\\n </Reports>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListJMeterReportsResponse>","errorExample":""}]', + 'title' => 'ListJMeterReports', + ], + 'StartDebuggingJMeterScene' => [ + 'summary' => 'Debugs a JMeter scenario.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '场景id', + 'description' => 'The ID of the scenario that you want to debug.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ReportId' => [ + 'description' => 'The ID of the debugging report.'."\n", + 'type' => 'string', + 'example' => 'MH0SU1I', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"ReportId\\": \\"MH0SU1I\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartDebuggingJMeterSceneResponse>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <ReportId>MH0SU1I</ReportId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StartDebuggingJMeterSceneResponse>","errorExample":""}]', + 'title' => 'StartDebuggingJMeterScene', + ], + 'StartTestingJMeterScene' => [ + 'summary' => 'Starts performance testing in 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' => '场景id', + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ReportId' => [ + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'example' => 'MH0SU1I', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"\\",\\n \\"ReportId\\": \\"MH0SU1I\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartTestingJMeterSceneResponse>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <ReportId>MH0SU1I</ReportId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StartTestingJMeterSceneResponse>","errorExample":""}]', + 'title' => 'StartTestingJMeterScene', + ], + 'StopDebuggingJMeterScene' => [ + 'summary' => 'Stops the debugging of 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' => '场景id', + 'description' => 'The ID of the scenario that you want to stop debugging.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample success response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was returned, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was returned, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was returned, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopDebuggingJMeterSceneResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StopDebuggingJMeterSceneResponse>","errorExample":""}]', + 'title' => 'StopDebuggingJMeterScene', + ], + 'StopTestingJMeterScene' => [ + 'summary' => 'Stops performance testing by using 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' => '场景id', + 'description' => 'The ID of the JMeter scenario.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopTestingJMeterSceneResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StopTestingJMeterSceneResponse>","errorExample":""}]', + 'title' => 'StopTestingJMeterScene', + ], + 'GetJMeterSceneRunningData' => [ + 'summary' => 'Queries data that is generated during the stress testing of a JMeter scenario based on the ID of the scenario.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '场景id', + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DocumentUrl' => [ + 'description' => 'The URL that is used to access the document.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RunningData' => [ + 'title' => '运行中的数据', + 'description' => 'The running data.'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'example' => 'DYYPZIH', + ], + 'ErrorMessage' => [ + 'title' => '压测流程的失败信息', + 'description' => 'The error message returned for the stress testing process. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'Engine lease failed.'."\n", + ], + 'ReportId' => [ + 'title' => '压测任务id，也即报告id', + 'description' => 'The stress testing task ID. This ID also means the report ID.'."\n", + 'type' => 'string', + 'example' => 'DYYPLDKS', + ], + 'HasError' => [ + 'title' => '压测流程是否出错', + 'description' => 'Indicates whether an error occurs in the stress testing process.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SceneName' => [ + 'title' => '场景名称', + 'description' => 'The scenario name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'HoldFor' => [ + 'title' => '压测计划持续时间，单位s', + 'description' => 'The duration of the stress testing plan. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'AgentCount' => [ + 'title' => '压测引擎数量', + 'description' => 'The number of stress testing engines.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AgentIdList' => [ + 'title' => '压测引擎列表', + 'description' => 'The stress testing engines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The stress testing engine.'."\n", + 'type' => 'string', + 'example' => '["116.19.153.94_3088020"]', + ], + ], + 'Concurrency' => [ + 'title' => '并发量', + 'description' => 'The concurrency.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'HasReport' => [ + 'title' => '是否生成了报告', + 'description' => 'Indicates whether the report is generated.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsDebugging' => [ + 'title' => '是否是调试', + 'description' => 'Indicates whether a debugging is performed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Status' => [ + 'title' => '状态', + 'description' => 'The stress testing status of the scenario.'."\n", + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Vum' => [ + 'title' => '目前消耗的vum', + 'description' => 'The consumed Virtual User Minutes (VUM).'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'StartTimeTS' => [ + 'title' => '压测计划开始时间戳，单位ms', + 'description' => 'The timestamp when the stress testing is scheduled to start. Unit: ms.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639970040000', + ], + 'StageName' => [ + 'title' => '当前所处阶段', + 'description' => 'The current stage.'."\n", + 'type' => 'string', + 'example' => '任务执行', + ], + 'AllSampleStat' => [ + 'title' => '场景整体的采样状态', + 'description' => 'The sampling status of the scenario.'."\n", + 'type' => 'object', + 'example' => '{ "failTps":0,"successRtAvg":33,"successRtMin":29,"successRtSum":99407, "rtAvg":33.459104678559406,"rtMin":29,"failRtMax":0,"duration":997, "samplerId":-1, "successRtMax":133,"fullStat":{ "requestBytesSum":629926,"successRtAvg":33,"successRtMin":29,"successRtSum":174551,"count":5206,"rtSeg99":53, "successTps":2397.9732842008293,"rtSeg90":36, "rtSeg50":32, "rtSeg99Sum":53,"rtAvg":33.528812908182864, "rtMin":29, "failRtMax":0,"duration":2171, "successCount":5206, "rtSegStatCount":1,"tps":2397.9732842008293 }, "successCount":2971, "failRtSum":0,"failCount":0,"count":2971,"concurrency":100, "successTps":2979.939819458375,"tps":2979.939819458375,"failRtAvg":0, "failRtMin":0, "rtMax":133}', + ], + 'SampleStatList' => [ + 'title' => '每一个采样器的状态', + 'description' => 'The status of samplers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The status of each sampler.'."\n", + 'type' => 'object', + 'example' => '{ "failTps":0,"successRtAvg":33,"successRtMin":29,"successRtSum":99407, "rtAvg":33.459104678559406,"rtMin":29,"failRtMax":0,"duration":997, "samplerId":-1, "successRtMax":133,"fullStat":{ "requestBytesSum":629926,"successRtAvg":33,"successRtMin":29,"successRtSum":174551,"count":5206,"rtSeg99":53, "successTps":2397.9732842008293,"rtSeg90":36, "rtSeg50":32, "rtSeg99Sum":53,"rtAvg":33.528812908182864, "rtMin":29, "failRtMax":0,"duration":2171, "successCount":5206, "rtSegStatCount":1,"tps":2397.9732842008293 }, "successCount":2971, "failRtSum":0,"failCount":0,"count":2971,"concurrency":100, "successTps":2979.939819458375,"tps":2979.939819458375,"failRtAvg":0, "failRtMin":0, "rtMax":133}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'ReportNotExist', + 'errorMessage' => 'The report does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"任务执行\\",\\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}","errorExample":""},{"type":"xml","example":"<GetJMeterSceneRunningDataResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n <DocumentUrl>空</DocumentUrl>\\n <RunningData>\\n <SceneId>DYYPZIH</SceneId>\\n <SceneName>test</SceneName>\\n <HoldFor>600</HoldFor>\\n <AgentCount>2</AgentCount>\\n <AgentIdList>[\\"116.19.153.94_3088020\\"]</AgentIdList>\\n <Concurrency>1000</Concurrency>\\n <HasReport>false</HasReport>\\n <IsDebugging>false</IsDebugging>\\n <Status>RUNNING</Status>\\n <Vum>100</Vum>\\n <StartTimeTS>1639970040000</StartTimeTS>\\n <StageName>任务执行</StageName>\\n <SampleStatList/>\\n </RunningData>\\n</GetJMeterSceneRunningDataResponse>","errorExample":""}]', + 'title' => 'GetJMeterSceneRunningData', + ], + 'AdjustJMeterSceneSpeed' => [ + 'summary' => 'Adjusts the JMeter load.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'title' => '报告id', + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'title' => '要调整到的压力值', + 'description' => 'The load to which you want to adjust.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DC4E31DDA77-6745-4925-B423-4E89VV34221A', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReportId' => [ + 'title' => '报告ID', + 'description' => 'The ID of the report.'."\n", + 'type' => 'string', + 'example' => 'DYYPZIH', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + '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"}]', + 'title' => 'AdjustJMeterSceneSpeed', + ], + 'RemoveOpenJMeterScene' => [ + 'summary' => 'Removes 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' => '场景ID', + 'description' => 'The ID of the scenario that you want to remove.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveOpenJMeterSceneResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RemoveOpenJMeterSceneResponse>","errorExample":""}]', + 'title' => 'RemoveOpenJMeterScene', + ], + '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.'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneName' => [ + 'title' => '场景名', + 'description' => 'The scenario name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'EnvironmentId' => [ + 'title' => '关联的环境id', + 'description' => 'The ID of the environment associated with the scenario.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'I8PZIH', + ], + 'JmeterPluginLabel' => [ + 'title' => 'jmeter插件的环境标签', + 'description' => 'The JMeter plug-in tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'maxLength' => 32, + 'pattern' => '^[A-Z0-9]+$', + ], + 'TestFile' => [ + 'title' => '测试文件', + 'description' => 'The test file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'baidu.jmx', + ], + 'FileList' => [ + 'title' => '文件列表', + 'description' => 'The test files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the test file.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the test file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'baidu.jmx', + ], + 'FileOssAddress' => [ + 'title' => '文件公网可访问的oss地址', + 'description' => 'The Object Storage Service (OSS) path that is used to access the test file over the Internet.'."\n" + ."\n" + .'> Only test files in the China (Shanghai) region can be accessed.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'https://test.cn-shanghai.aliyuncs.com/baidu.jmx', + ], + 'Md5' => [ + 'title' => '文件的MD5', + 'description' => 'The MD5 hash of the test file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DA70F97A74D76B6A3BEF9CC8AE0D89EB', + ], + 'FileId' => [ + 'title' => '文件id', + 'description' => 'The file ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '61232', + ], + 'SplitCsv' => [ + 'title' => '是否切分，仅针对csv有效', + 'description' => 'Specifies whether to split the test file. This parameter is valid only for CSV files.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'FileSize' => [ + 'title' => '文件大小，单位byte', + 'description' => 'The file size. The total file size cannot exceed 500 MB. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '28880', + ], + 'Tags' => [ + 'title' => '文件tag', + 'description' => 'The file tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'JMeterProperties' => [ + 'title' => 'Jmeter属性', + 'description' => 'The JMeter properties.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the property.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The property name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https.sessioncontext.shared', + ], + 'Value' => [ + 'description' => 'The values of the property.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RampUp' => [ + 'title' => '预热时间', + 'description' => 'The ramp-up period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + 'Steps' => [ + 'title' => '预热阶段', + 'description' => 'The number of ramp-up steps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Concurrency' => [ + 'title' => '最大并发', + 'description' => 'The maximum concurrency that is determined by the resource plans of users. You must configure this parameter when the mode is set to CONCURRENCY.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'Duration' => [ + 'title' => '压测持续时间', + 'description' => 'The stress testing duration. The maximum stress testing duration is no more than one day, Unit: seconds. Valid values: 60 to 86400.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '600', + ], + 'SceneId' => [ + 'title' => '场景ID', + 'description' => 'The scenario ID. If you do not configure this parameter, the system creates a scenario. If you configure this parameter, the system updates the scenario corresponding to the ID specified by this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DYYPZIH', + ], + 'IsVpcTest' => [ + 'title' => '是否为VPC测试，默认为false表示公网测试，此值为true时VPC相关配置才生效', + 'description' => 'Specifies whether the test is a virtual private cloud (VPC) test. The default value is false, which indicates a public network test. VPC-related settings take effect only when you set this parameter to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + 'DnsCacheConfig' => [ + 'title' => 'DNS配置', + 'description' => 'The settings of Domain Name System (DNS).'."\n", + 'type' => 'object', + 'properties' => [ + 'ClearCacheEachIteration' => [ + 'description' => 'Specifies whether to clear the cache in each iteration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DnsServers' => [ + 'description' => 'The DNS servers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The DNS server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[8.8.8.8]', + ], + 'required' => false, + ], + 'HostTable' => [ + 'description' => 'The table that contains bound domain names.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '"ns.server.om":"8.8.8.8"', + 'description' => 'The record of the bound domain name.'."\n", + ], + ], + ], + 'required' => false, + ], + 'AgentCount' => [ + 'title' => '施压引擎数量', + 'description' => 'The number of stress testers.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + 'RegionId' => [ + 'title' => 'region的id，VPC压测时配置', + 'description' => 'The region ID that is specified in the VPC test.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'VpcId' => [ + 'title' => 'vpc的id，VPC压测时配置', + 'description' => 'The VPC ID that is specified in the VPC test.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze2sahjdgahsebjkqhf4pyj', + ], + 'SecurityGroupId' => [ + 'title' => '安全组id，VPC压测时配置', + 'description' => 'The security group ID that is specified in the VPC test.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-2zeid0dd7bhahsgdahspaly', + ], + 'VSwitchId' => [ + 'title' => '交换机id，VPC压测时配置', + 'description' => 'The vSwitch ID that is specified in the VPC test.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2zehsgdhsahw1r', + ], + 'SyncTimerType' => [ + 'title' => 'synchronizing timer 类型', + 'description' => 'The type of the synchronization timer in JMeter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL', + ], + 'ConstantThroughputTimerType' => [ + 'title' => 'constantThroughputTimerType', + 'description' => 'The type of the synchronization timer with fixed throughput in JMeter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL', + ], + 'Mode' => [ + 'title' => '压力模式', + 'description' => 'The stress model.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CONCURRENCY', + ], + 'StartRps' => [ + 'description' => 'The initial RPS that takes effect in RPS mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'MaxRps' => [ + 'description' => 'The maximum RPS that takes effect in RPS mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'StartConcurrency' => [ + 'description' => 'The initial concurrency that takes effect in concurrency mode. You must configure this parameter when the mode is set to CONCURRENCY.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'RegionalCondition' => [ + 'description' => 'The requirements for the regions of the stress testers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number of stress testers in a specific region.'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Amount' => [ + 'description' => 'The number of stress tests. The sum of the number of stress tests in all regions must be equal to the AgentCount value of a specified scenario.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The ID of the created or updated scenario.'."\n", + 'type' => 'string', + 'example' => 'DYYPZIH', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SaveOpenJMeterSceneFail', + 'errorMessage' => 'The scene cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SceneId\\": \\"DYYPZIH\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"Message\\": \\"空\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SaveOpenJMeterSceneResponse>\\n <SceneId>DYYPZIH</SceneId>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SaveOpenJMeterSceneResponse>","errorExample":""}]', + 'title' => 'SaveOpenJMeterScene', + ], + 'GetOpenJMeterScene' => [ + 'summary' => 'Queries information about a JMeter scenario.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '场景ID', + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DYYPZIH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Scene' => [ + 'title' => '场景详情', + 'description' => 'The information about the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'SceneName' => [ + 'title' => '场景名', + 'description' => 'The name of the scenario.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The ID of the scenario.'."\n", + 'type' => 'string', + 'example' => 'DYYPZIH', + ], + 'EnvironmentId' => [ + 'title' => '环境id', + 'description' => 'The ID of the environment.'."\n", + 'type' => 'string', + 'example' => 'EEDT7', + ], + 'BaseInfo' => [ + 'title' => '基本信息', + 'description' => 'The basic information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Remark' => [ + 'title' => '备注', + 'description' => 'The comment.'."\n", + 'type' => 'string', + 'example' => '小心压测', + ], + 'Principal' => [ + 'title' => '场景压测负责人', + 'description' => 'The person who takes charge of the performance testing.'."\n", + 'type' => 'string', + 'example' => 'test-person', + ], + 'Resource' => [ + 'title' => '场景来源', + 'description' => 'The origin of the scenario.'."\n", + 'type' => 'string', + 'example' => 'create', + ], + 'CreateName' => [ + 'title' => '创建人名', + 'description' => 'The name of the creator.'."\n", + 'type' => 'string', + 'example' => '张三', + ], + 'ModifyName' => [ + 'title' => '修改人名', + 'description' => 'The name of the modifier.'."\n", + 'type' => 'string', + 'example' => '里斯', + ], + 'OperateType' => [ + 'title' => '操作类型', + 'description' => 'The type of the operation.'."\n", + 'type' => 'string', + 'example' => '保存去压测', + ], + ], + ], + 'FileList' => [ + 'title' => '文件列表', + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '文件ID', + 'description' => 'The ID of the file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '61660', + ], + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'example' => 'json.jar', + ], + 'FileOssAddress' => [ + 'title' => '文件地址', + 'description' => 'The Object Storage Service (OSS) URL of the file.'."\n", + 'type' => 'string', + 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', + ], + 'SplitCsv' => [ + 'title' => 'csv文件是否切分', + 'description' => 'Indicates whether the file is split.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Md5' => [ + 'title' => '文件的md5值', + 'description' => 'The MD5 value of the JAR package.'."\n", + 'type' => 'string', + 'example' => '43B584026CE5E570F3DE638FA7EEF9E0', + ], + 'FileSize' => [ + 'title' => '文件大小', + 'description' => 'The size of the file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => 'The type of the file.'."\n", + 'type' => 'string', + 'example' => 'jar', + ], + ], + ], + ], + 'TestFile' => [ + 'title' => '测试文件', + 'description' => 'The test file.'."\n", + 'type' => 'string', + 'example' => 'baidu.jmx', + ], + 'IsVpcTest' => [ + 'title' => '是否为VPC压测', + 'description' => 'Indicates whether the load is from a virtual private cloud (VPC).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Duration' => [ + 'title' => '压测持续时间，单位为s', + 'description' => 'The duration of the performance testing. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'DnsCacheConfig' => [ + 'title' => 'DNS配置', + 'description' => 'The DNS settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClearCacheEachIteration' => [ + 'title' => '是否清除缓存', + 'description' => 'Indicates whether the cache is cleared.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'DnsServers' => [ + 'title' => 'DNS服务器', + 'description' => 'The DNS servers'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The DNS server.'."\n", + 'type' => 'string', + 'example' => '["8.8.8.8"]', + ], + ], + 'HostTable' => [ + 'title' => '域名绑定', + 'description' => 'The domain name and its bounded IP address.'."\n", + 'type' => 'object', + 'example' => '{"server.com":"6.6.6.6"}', + ], + ], + ], + 'Concurrency' => [ + 'title' => '最大并发，并发模式下生效', + 'description' => 'The maximum number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'AgentCount' => [ + 'title' => '施压机数量', + 'description' => 'The number of load generators. A load generator supports up to 500 concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RampUp' => [ + 'title' => '递增时间，单位s', + 'description' => 'The period of time during which the load is gradually increased to the desired level. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Steps' => [ + 'title' => '递增阶梯数。预热时间和预热阶段数都不配置时 使用固定压力值 只配置预热时间，不配置阶段数时 使用均匀递增 预热时间和阶段数都配置时，并且steps<rampUp 使用阶梯递增 不能只配置steps，不配置rampUp 如果这样配置，默认使用固定压力值', + 'description' => 'The number of incremented users per step. If RampUp or Steps is not specified, the fixed load is used. If RampUp is specified but Steps is not specified, the load increases uniformly based on the value of RampUp. If RampUp and Steps are specified and Steps is less than RampUp, the load increases based on the value of Steps. You cannot specify Steps without specifying RampUp. If you do so, the fixed load is used.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RegionId' => [ + 'title' => 'VPC压测时配置', + 'description' => 'The region ID. This parameter is returned if the load is from a VPC.'."\n", + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'VpcId' => [ + 'title' => 'vpc的id，VPC压测时配置', + 'description' => 'The ID of the VPC. This parameter is returned if the load is from a VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-2ze2sahjdgahsebjkqhf4pyj', + ], + 'SecurityGroupId' => [ + 'title' => '安全组id，VPC压测时配置', + 'description' => 'The ID of the security group. This parameter is returned if the load is from a VPC.'."\n", + 'type' => 'string', + 'example' => 'sg-2zeid0dd7bhahsgdahspaly', + ], + 'VSwitchId' => [ + 'title' => '交换机id，VPC压测时配置', + 'description' => 'The ID of the vSwitch. This parameter is returned if the load is from a VPC.'."\n", + 'type' => 'string', + 'example' => 'vsw-2zehsgdhsahw1r', + ], + 'SyncTimerType' => [ + 'title' => 'synchronizing timer 类型', + 'description' => 'The type of the synchronization timer.'."\n", + 'type' => 'string', + 'example' => 'GLOBAL', + ], + 'ConstantThroughputTimerType' => [ + 'title' => 'constantThroughputTimerType', + 'description' => 'The type of the constant throughput timer.'."\n", + 'type' => 'string', + 'example' => 'STAND_ALONE', + ], + 'Pool' => [ + 'title' => '压力来源。“”表示公网，intranet-vpc表示VPC', + 'description' => 'The origin of the load. "" indicates the Internet and intranet-vpc indicates the VPC.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Mode' => [ + 'title' => '施压模式，concurrency_mode表示并发压测,tps_mode表示RPS压测', + 'description' => 'The load application mode. Valid values: concurrency_mode and tps_mode.'."\n", + 'type' => 'string', + 'example' => 'concurrency_mode', + ], + 'StartRps' => [ + 'description' => 'The start requests per second (RPS). This parameter is returned if you set Mode to tps_mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'MaxRps' => [ + 'description' => 'The maximum RPS. This parameter is returned if you set Mode to tps_mode.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'StartConcurrency' => [ + 'description' => 'The start number of concurrent virtual users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'RegionalCondition' => [ + 'description' => 'Customized load generator settings for regions'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The number of load generators in a region'."\n", + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Amount' => [ + 'description' => 'The number of load generators.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"张三\\",\\n \\"ModifyName\\": \\"里斯\\",\\n \\"OperateType\\": \\"保存去压测\\"\\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}","errorExample":""},{"type":"xml","example":"<GetOpenJMeterSceneResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Scene>\\n <SceneName>test</SceneName>\\n <SceneId>DYYPZIH</SceneId>\\n <EnvironmentId>EEDT7</EnvironmentId>\\n <BaseInfo>\\n <Remark>小心压测</Remark>\\n <Principal>test-person</Principal>\\n <Resource>create</Resource>\\n <CreateName>张三</CreateName>\\n <ModifyName>里斯</ModifyName>\\n <OperateType>保存去压测</OperateType>\\n </BaseInfo>\\n <FileList>\\n <Id>61660</Id>\\n <FileName>json.jar</FileName>\\n <FileOssAddress>https://test.oss-cn-shanghai.aliyuncs.com/json.jar</FileOssAddress>\\n <SplitCsv>false</SplitCsv>\\n <Md5>43B584026CE5E570F3DE638FA7EEF9E0</Md5>\\n <FileSize>700</FileSize>\\n <FileType>jar</FileType>\\n </FileList>\\n <TestFile>baidu.jmx</TestFile>\\n <IsVpcTest>false</IsVpcTest>\\n <Duration>600</Duration>\\n <DnsCacheConfig>\\n <ClearCacheEachIteration>false</ClearCacheEachIteration>\\n <DnsServers>[\\"8.8.8.8\\"]</DnsServers>\\n </DnsCacheConfig>\\n <Concurrency>1000</Concurrency>\\n <AgentCount>2</AgentCount>\\n <RampUp>100</RampUp>\\n <Steps>3</Steps>\\n <RegionId>cn-beijing</RegionId>\\n <VpcId>vpc-2ze2sahjdgahsebjkqhf4pyj</VpcId>\\n <SecurityGroupId>sg-2zeid0dd7bhahsgdahspaly</SecurityGroupId>\\n <VSwitchId>vsw-2zehsgdhsahw1r</VSwitchId>\\n <SyncTimerType>GLOBAL</SyncTimerType>\\n <ConstantThroughputTimerType>STAND_ALONE</ConstantThroughputTimerType>\\n </Scene>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetOpenJMeterSceneResponse>","errorExample":""}]', + 'title' => 'GetOpenJMeterScene', + ], + 'ListOpenJMeterScenes' => [ + 'summary' => 'Queries JMeter scenarios based on a specified condition.', + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of scenarios to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '10', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '场景id', + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DYYPZIH', + ], + ], + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'title' => '场景名', + 'description' => 'The scenario name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'JMeterScene' => [ + 'description' => 'The scenarios.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'DurationStr' => [ + 'title' => '压测持续时间', + 'description' => 'The stress testing duration.'."\n", + 'type' => 'string', + 'example' => '10分钟', + ], + 'SceneId' => [ + 'title' => '场景id', + 'description' => 'The scenario ID.'."\n", + 'type' => 'string', + 'example' => 'DYYPZIH', + ], + 'SceneName' => [ + 'title' => '场景名', + 'description' => 'The scenario name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status of the scenario. Valid values:'."\n" + ."\n" + .'* PREPARING: The scenario is being prepared.'."\n" + .'* PREPARED: The scenario has been prepared.'."\n" + .'* STARTING: The scenario is starting.'."\n" + .'* RUNNING: The scenario is running.'."\n" + .'* STOPPING: The scenario is being stopped.'."\n" + .'* STOPPED: The scenario waits for startup'."\n", + 'type' => 'string', + 'example' => 'STOPPED', + ], + ], + ], + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of returned scenarios.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned scenarios.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'SceneNotExist', + 'errorMessage' => 'The scene does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"JMeterScene\\": [\\n {\\n \\"DurationStr\\": \\"10分钟\\",\\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}","errorExample":""},{"type":"xml","example":"<ListOpenJMeterScenesResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <JMeterScene>\\n <DurationStr>10分钟</DurationStr>\\n <SceneId>DYYPZIH</SceneId>\\n <SceneName>test</SceneName>\\n </JMeterScene>\\n <Code>200</Code>\\n <Success>true</Success>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n</ListOpenJMeterScenesResponse>","errorExample":""}]', + 'title' => 'ListOpenJMeterScenes', + ], + 'RemoveEnv' => [ + 'summary' => 'Removes the JMeter environment that corresponds to a specific JMeter environment ID.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EnvId', + 'in' => 'query', + 'schema' => [ + 'title' => '要删除的环境ID', + 'description' => 'The ID of the environment that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10YPA8H', + 'maxLength' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 503 => [ + [ + 'errorCode' => 'EnvNotExist', + 'errorMessage' => 'The env does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveEnvResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</RemoveEnvResponse>","errorExample":""}]', + 'title' => 'RemoveEnv', + ], + '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 JMeter environment.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnvId' => [ + 'title' => '环境id，不填表示新建环境，填了表示修改该环境', + 'description' => 'The ID of the JMeter environment. To create a JMeter environment, leave this parameter empty. To update a JMeter environment, specify the ID of the environment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10YPA8H', + 'maxLength' => 20, + ], + 'EnvName' => [ + 'title' => '环境名称', + 'description' => 'The name of the environment.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-create', + 'maxLength' => 50, + 'minLength' => 1, + ], + 'Files' => [ + 'title' => '环境依赖的文件', + 'description' => 'The files on which the environment depends.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the file. Make sure that the file name is the same as the file name in the value of **FileOssAddress**.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'json.jar', + 'maxLength' => 100, + 'minLength' => 1, + ], + 'FileOssAddress' => [ + 'title' => '文件oss地址，目前只支持上海region的oss地址', + 'description' => 'The Object Storage Service (OSS) URL of the file. Make sure that the file is accessible from the Internet.'."\n" + ."\n" + .'> Only OSS URLs in the China (Shanghai) region are supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', + 'maxLength' => 200, + 'minLength' => 1, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 80, + 'minItems' => 0, + ], + 'Properties' => [ + 'title' => 'jmeter属性', + 'description' => 'The JMeter attributes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The JMeter attribute.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '属性名', + 'description' => 'The name of the attribute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'remote_hosts', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Value' => [ + 'title' => '属性值', + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The description of the attribute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '远程主机', + 'maxLength' => 1024, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'JmeterPluginLabel' => [ + 'title' => 'jmeter插件的环境标签', + 'description' => 'The extension label.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'maxLength' => 32, + 'pattern' => '^[A-Z0-9]+$', + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'EnvId' => [ + 'title' => '操作的环境id', + 'description' => 'The ID of the environment.'."\n", + 'type' => 'string', + 'example' => '10YPA8H', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 503 => [ + [ + 'errorCode' => 'SaveEnvFail', + 'errorMessage' => 'The env cannot be empty.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"A8E16480-15C1-555A-922F-B736A005E52D\\",\\n \\"HttpStatusCode\\": 0,\\n \\"EnvId\\": \\"10YPA8H\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SaveEnvResponse>\\n <Message>空</Message>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <EnvId>10YPA8H</EnvId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SaveEnvResponse>","errorExample":""}]', + 'title' => 'SaveEnv', + ], + 'ListEnvs' => [ + 'summary' => 'Queries the information about JMeter environments.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of environments per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'EnvId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境ID', + 'description' => 'The ID of the environment. If you specify this parameter, the operation returns the information about the environment identified by the ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10YPA8H', + ], + ], + [ + 'name' => 'EnvName', + 'in' => 'query', + 'schema' => [ + 'title' => '环境名', + 'description' => 'The keyword of the environment name. If you specify this parameter, the operation returns the information about the environments whose names contain the keyword.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-create', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The sample response.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of environments.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'A8E16480-15C1-555A-922F-B736A005E52D', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of environments per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Envs' => [ + 'title' => '环境列表', + 'description' => 'The environments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the environment was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637053715165', + ], + 'RunningScenes' => [ + 'title' => '关联的场景id', + 'description' => 'The IDs of the scenarios that run in the environment.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IDs of the scenarios.'."\n", + 'type' => 'string', + 'example' => '[10YPA8H, 0PYP8WH]', + ], + ], + 'EnvVersion' => [ + 'title' => '依赖的jmeter版本', + 'description' => 'The JMeter version of the environment.'."\n", + 'type' => 'string', + 'example' => '5.0', + ], + 'ModifiedTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the environment was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637053719165', + ], + 'Files' => [ + 'title' => '包含的jar包', + 'description' => 'The JAR files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileSize' => [ + 'title' => '文件大小，单位为Byte', + 'description' => 'The size of the file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '788', + ], + 'Md5' => [ + 'title' => 'jar包的md5值', + 'description' => 'The MD5 checksum of the file.'."\n", + 'type' => 'string', + 'example' => '43B584026CE5E570F3DE638FA7EEF9E0', + ], + 'FileName' => [ + 'title' => '文件名', + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'example' => 'json.jar', + ], + 'FileOssAddress' => [ + 'title' => '文件的oss地址', + 'description' => 'The OSS address of the file.'."\n", + 'type' => 'string', + 'example' => 'https://test.oss-cn-shanghai.aliyuncs.com/json.jar', + ], + 'FileId' => [ + 'title' => '文件ID', + 'description' => 'The ID of the file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '61660', + ], + ], + ], + ], + 'RelatedScenes' => [ + 'title' => '关联的场景', + 'description' => 'The scenarios related to the environment.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The scenario.'."\n", + 'type' => 'string', + 'example' => '[10YPA8H, 0PYP8WH]', + ], + ], + 'UsedCapacity' => [ + 'title' => '环境的文件总大小', + 'description' => 'The total size of the environment file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26668', + ], + 'EnvName' => [ + 'title' => '环境名', + 'description' => 'The name of the environment.'."\n", + 'type' => 'string', + 'example' => 'test-create', + ], + 'EnvId' => [ + 'title' => '环境ID', + 'description' => 'The ID of the environment.'."\n", + 'type' => 'string', + 'example' => '86S1LH', + ], + 'Properties' => [ + 'title' => 'jmeter属性', + 'description' => 'The JMeter attributes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The attribute.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '属性名', + 'description' => 'The name of the attribute.'."\n", + 'type' => 'string', + 'example' => 'remote_hosts', + ], + 'Value' => [ + 'title' => '属性值', + 'description' => 'The value of the attribute.'."\n", + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The description of the attribute.'."\n", + 'type' => 'string', + 'example' => '远程主机', + ], + ], + ], + ], + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 503 => [ + [ + 'errorCode' => 'EnvNotExist', + 'errorMessage' => 'The env does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": \\"远程主机\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListEnvsResponse>\\n <TotalCount>100</TotalCount>\\n <RequestId>A8E16480-15C1-555A-922F-B736A005E52D</RequestId>\\n <Message>空</Message>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Envs>\\n <CreateTime>1637053715165</CreateTime>\\n <RunningScenes>[10YPA8H, 0PYP8WH]</RunningScenes>\\n <EnvVersion>5.0</EnvVersion>\\n <ModifiedTime>1637053719165</ModifiedTime>\\n <Files>\\n <FileSize>788</FileSize>\\n <Md5>43B584026CE5E570F3DE638FA7EEF9E0</Md5>\\n <FileName>json.jar</FileName>\\n <FileOssAddress>https://test.oss-cn-shanghai.aliyuncs.com/json.jar</FileOssAddress>\\n <FileId>61660</FileId>\\n </Files>\\n <RelatedScenes>[10YPA8H, 0PYP8WH]</RelatedScenes>\\n <UsedCapacity>26668</UsedCapacity>\\n <EnvName>test-create</EnvName>\\n <EnvId>86S1LH</EnvId>\\n <Properties>\\n <Name>remote_hosts</Name>\\n <Value>127.0.0.1</Value>\\n <Description>远程主机</Description>\\n </Properties>\\n </Envs>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListEnvsResponse>","errorExample":""}]', + 'title' => 'ListEnvs', + ], + 'GetAllRegions' => [ + 'summary' => 'Queries all supported regions.', + '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 returned message. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '73D16B8D-0FCD-5596-B7BE-A47042989318', + ], + 'AllRegions' => [ + 'description' => 'The supported regions.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The supported region.'."\n", + 'example' => '', + ], + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code. If the request was successful, no data is returned.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Code', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + '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"}]', + 'title' => 'GetAllRegions', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483646', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze22asdfuwiea2ebjkqhf4pyj', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Vpcs' => [ + 'description' => 'The VPCs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6gc56wdjpafoiwej6adqb4qn72xtw', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcName' => [ + 'description' => 'The name of the VPC.'."\n", + 'type' => 'string', + 'example' => 'shanghai-vpc', + ], + 'CidrBlock' => [ + 'description' => 'The IPv4 CIDR block of the VPC.'."\n", + 'type' => 'string', + 'example' => '172.16.80.0/20', + ], + 'Description' => [ + 'description' => 'The description of the VPC.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the VPC belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfm3fzmgkehpewjertna', + ], + 'VSwitchIds' => [ + 'description' => 'The vSwitches.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1s21fe8r3esdslplvcv5240', + ], + ], + 'RouterTableIds' => [ + 'description' => 'The IDs of the route tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the route table.'."\n", + 'type' => 'string', + 'example' => 'vtb-bp11tkmteho3svealseipea6h', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEE46204-E1CF-5F48-B094-67362DD4B73F', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Code', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + '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"}]', + 'title' => 'GetUserVpcs', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483646', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp10xjz7c7oqjgasodihj1kx7t', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupCount' => [ + 'description' => 'The number of security groups.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'SecurityGroupList' => [ + 'description' => 'The security groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The security group.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6tar2ohlasdhsatjln37h30bv', + ], + 'Description' => [ + 'description' => 'The description of the security group.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp16bt3zuugxpfjkasdfvthxth8', + ], + 'SecurityGroupName' => [ + 'description' => 'The name of the security group.'."\n", + 'type' => 'string', + 'example' => 'my-security-group', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '61B15017-1A68-5C47-834F-87E2BBC44F2C', + ], + 'Message' => [ + 'description' => 'The error message. If the operation is successful, this parameter is not returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Code', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + '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"}]', + 'title' => 'GetUserVpcSecurityGroup', + ], + '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 number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483646', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-2ze22scdz2ebdfjasdfjkqhf4pyj', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchCount' => [ + 'description' => 'The number of vSwitches.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0235E5FC-4C7C-5F0C-843C-FC674F15F947', + ], + 'Message' => [ + 'description' => 'The returned message. If the request was successful, this parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'The number of returned entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VSwitchList' => [ + 'description' => 'The vSwitches.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9bpdaebft6j23fesdf84v2f1um3a', + ], + 'MaxAgentCount' => [ + 'description' => 'The maximum number of stress testers to be added.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'AvailableIpAddressCount' => [ + 'description' => 'The number of available IP addresses in the vSwitch.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1eil9df23rsd8l1sevebiszooj', + ], + 'VSwitchName' => [ + 'description' => 'The vSwitch name.'."\n", + 'type' => 'string', + 'example' => 'my-vswitch', + ], + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => 'The system status code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Code', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + '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"}]', + 'title' => 'GetUserVpcVSwitch', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'pts.aliyuncs.com', + ], + ], +]; |