查询场景的结构、施压等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
pts:GetPtsScene |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SceneId | string | 是 | 场景 ID。更多信息,请参见 OpenAPI 创建接口参数说明。 | NKJBSH |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"HttpStatusCode": 200,
"Message": "空",
"RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
"Scene": {
"AdvanceSetting": {
"ConnectionTimeoutInSecond": 5,
"DomainBindingList": [
{
"Domain": "www.aliyundoc.com",
"Ips": [
"[1.1.1.1]"
]
}
],
"LogRate": 1,
"SuccessCode": "429,304"
},
"CreateTime": "2021-02-26 15:30:30",
"FileParameterList": [
{
"FileName": "city.csv",
"FileOssAddress": "https://test.oss-cn-shanghai.aliyuncs.com/json.jar"
}
],
"GlobalParameterList": [
{
"ParamName": "userName",
"ParamValue": "lisi"
}
],
"Headers": [
{
"Name": "key1",
"Value": "value1"
}
],
"LoadConfig": {
"AgentCount": 1,
"ApiLoadConfigList": [
{
"ApiId": "GBFDCV8",
"RpsBegin": 10,
"RpsLimit": 20
}
],
"AutoStep": false,
"Configuration": {
"AllConcurrencyBegin": 100,
"AllConcurrencyLimit": 200,
"AllRpsBegin": 100,
"AllRpsLimit": 200
},
"Increment": 10,
"KeepTime": 2,
"MaxRunningTime": 2,
"RelationLoadConfigList": [
{
"ConcurrencyBegin": 10,
"ConcurrencyLimit": 20,
"RelationId": "HNBGS7M"
}
],
"TestMode": "TPS",
"VpcLoadConfig": {
"RegionId": "cn-beijing",
"SecurityGroupId": "sg-jkasgfieiajidsjakjscb",
"VSwitchId": "vsw-skjfhlahsljkhsfalkjdoiw",
"VpcId": "vpc-akjhsdajgjsfggahjkga"
}
},
"ModifiedTime": "2021-03-26 15:30:30",
"RelationList": [
{
"ApiList": [
{
"ApiId": "GBFDCV8",
"ApiName": "下单",
"Body": {
"BodyValue": "{\\\"key1\\\":\\\"111\\\",\\\"key2\\\":\\\"222\\\"}",
"ContentType": "application/x-www-form-urlencoded"
},
"CheckPointList": [
{
"CheckPoint": "userId",
"CheckType": "EXPORTED_PARAM",
"ExpectValue": "111",
"Operator": "ctn"
}
],
"ExportList": [
{
"Count": "0",
"ExportName": "data.username",
"ExportType": "BODY_JSON",
"ExportValue": "username"
}
],
"HeaderList": [
{
"HeaderName": "userId",
"HeaderValue": "1111"
}
],
"Method": "GET",
"RedirectCountLimit": 5,
"TimeoutInSecond": 5,
"Url": "https://www.aliyundoc.com"
}
],
"FileParameterExplainList": [
{
"BaseFile": true,
"CycleOnce": true,
"FileName": "city.csv",
"FileParamName": "userName,age"
}
],
"RelationId": "HNBGS7M",
"RelationName": "下单链路"
}
],
"SceneId": "BGFJ7GV",
"SceneName": "下单场景",
"Status": "Draft:草稿\nWaitStart:待启动\nDebugging:调试中\nRunning:运行中\n"
},
"Success": true
}
示例
正常返回示例
JSON
格式
{
"Message": "空",
"RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
"HttpStatusCode": 200,
"Scene": {
"Status": "Running",
"LoadConfig": {
"ApiLoadConfigList": {
"RpsBegin": 10,
"RpsLimit": 20,
"ApiId": "GBFDCV8"
},
"MaxRunningTime": 2,
"RelationLoadConfigList": {
"ConcurrencyBegin": 10,
"ConcurrencyLimit": 20,
"RelationId": "HNBGS7M"
},
"Configuration": {
"AllRpsBegin": 100,
"AllConcurrencyBegin": 100,
"AllConcurrencyLimit": 200,
"AllRpsLimit": 200
},
"AgentCount": 1,
"TestMode": "TPS"
},
"FileParameterList": {
"FileOssAddress": "https://test.oss-cn-shanghai.aliyuncs.com/json.jar",
"FileName": "city.csv"
},
"ModifiedTime": "2021-03-26 15:30:30",
"AdvanceSetting": {
"LogRate": 1,
"DomainBindingList": {
"Domain": "www.aliyundoc.com",
"Ips": "[1.1.1.1]"
},
"ConnectionTimeoutInSecond": 5,
"SuccessCode": "429,304"
},
"CreateTime": "2021-02-26 15:30:30",
"RelationList": {
"RelationName": "下单链路",
"FileParameterExplainList": {
"CycleOnce": true,
"FileParamName": "userName,age",
"FileName": "city.csv",
"BaseFile": true
},
"ApiList": {
"ApiId": "GBFDCV8",
"CheckPointList": {
"CheckType": "EXPORTED_PARAM",
"Operator": "ctn",
"ExpectValue": 111,
"CheckPoint": "userId"
},
"HeaderList": {
"HeaderValue": 1111,
"HeaderName": "userId"
},
"TimeoutInSecond": 5,
"ExportList": {
"ExportType": "BODY_JSON",
"ExportValue": "username",
"ExportName": "data.username",
"Count": 0
},
"Url": "https://www.aliyundoc.com",
"Method": "GET",
"Body": {
"BodyValue": "{\\\"key1\\\":\\\"111\\\",\\\"key2\\\":\\\"222\\\"}",
"ContentType": "application/x-www-form-urlencoded"
},
"RedirectCountLimit": 5,
"ApiName": "下单"
},
"RelationId": "HNBGS7M"
},
"SceneName": "下单场景",
"SceneId": "BGFJ7GV",
"GlobalParameterList": {
"ParamName": "userName",
"ParamValue": "lisi"
}
},
"Code": 200,
"Success": true
}
XML
格式
<GetPtsSceneResponse>
<Message>空</Message>
<RequestId>DC4E3177-6745-4925-B423-4E89VV34221A</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Scene>
<Status>Running</Status>
<LoadConfig>
<ApiLoadConfigList>
<RpsBegin>10</RpsBegin>
<RpsLimit>20</RpsLimit>
<ApiId>GBFDCV8</ApiId>
</ApiLoadConfigList>
<MaxRunningTime>2</MaxRunningTime>
<RelationLoadConfigList>
<ConcurrencyBegin>10</ConcurrencyBegin>
<ConcurrencyLimit>20</ConcurrencyLimit>
<RelationId>HNBGS7M</RelationId>
</RelationLoadConfigList>
<Configuration>
<AllRpsBegin>100</AllRpsBegin>
<AllConcurrencyBegin>100</AllConcurrencyBegin>
<AllConcurrencyLimit>200</AllConcurrencyLimit>
<AllRpsLimit>200</AllRpsLimit>
</Configuration>
<AgentCount>1</AgentCount>
<TestMode>TPS</TestMode>
</LoadConfig>
<FileParameterList>
<FileOssAddress>https://test.oss-cn-shanghai.aliyuncs.com/json.jar</FileOssAddress>
<FileName>city.csv</FileName>
</FileParameterList>
<ModifiedTime>2021-03-26 15:30:30</ModifiedTime>
<AdvanceSetting>
<LogRate>1</LogRate>
<DomainBindingList>
<Domain>www.aliyundoc.com</Domain>
<Ips>[1.1.1.1]</Ips>
</DomainBindingList>
<ConnectionTimeoutInSecond>5</ConnectionTimeoutInSecond>
<SuccessCode>429,304</SuccessCode>
</AdvanceSetting>
<CreateTime>2021-02-26 15:30:30</CreateTime>
<RelationList>
<RelationName>下单链路</RelationName>
<FileParameterExplainList>
<CycleOnce>true</CycleOnce>
<FileParamName>userName,age</FileParamName>
<FileName>city.csv</FileName>
<BaseFile>true</BaseFile>
</FileParameterExplainList>
<ApiList>
<ApiId>GBFDCV8</ApiId>
<CheckPointList>
<CheckType>EXPORTED_PARAM</CheckType>
<Operator>ctn</Operator>
<ExpectValue>111</ExpectValue>
<CheckPoint>userId</CheckPoint>
</CheckPointList>
<HeaderList>
<HeaderValue>1111</HeaderValue>
<HeaderName>userId</HeaderName>
</HeaderList>
<TimeoutInSecond>5</TimeoutInSecond>
<ExportList>
<ExportType>BODY_JSON</ExportType>
<ExportValue>username</ExportValue>
<ExportName>data.username</ExportName>
<Count>0</Count>
</ExportList>
<Url>https://www.aliyundoc.com</Url>
<Method>GET</Method>
<Body>
<BodyValue>{\"key1\":\"111\",\"key2\":\"222\"}</BodyValue>
<ContentType>application/x-www-form-urlencoded</ContentType>
</Body>
<RedirectCountLimit>5</RedirectCountLimit>
<ApiName>下单</ApiName>
</ApiList>
<RelationId>HNBGS7M</RelationId>
</RelationList>
<SceneName>下单场景</SceneName>
<SceneId>BGFJ7GV</SceneId>
<GlobalParameterList>
<ParamName>userName</ParamName>
<ParamValue>lisi</ParamValue>
</GlobalParameterList>
</Scene>
<Code>200</Code>
<Success>true</Success>
</GetPtsSceneResponse>
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | GetPtsSceneFail | The scene does not exit |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-12-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |