文档

GetPtsScene - 查询场景

更新时间:

查询场景的结构、施压等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pts:GetPtsScene
  • acs:pts::{#accountId}:*

请求参数

名称类型必填描述示例值
SceneIdstring

场景 ID。更多信息,请参见 OpenAPI 创建接口参数说明

NKJBSH

返回参数

名称类型描述示例值
object
Messagestring

错误提示信息,若成功则为空。

RequestIdstring

请求 ID。

DC4E3177-6745-4925-B423-4E89VV34221A
HttpStatusCodeinteger

HTTP 状态码。

200
Sceneobject

场景结构。

Statusstring

场景状态。

Draft:草稿 WaitStart:待启动 Debugging:调试中 Running:运行中
LoadConfigobject

施压配置信息。

ApiLoadConfigListobject []

API 施压配置信息。

RpsBegininteger

起始 RPS。

10
RpsLimitinteger

最大 RPS。

20
ApiIdstring

API ID。可以根据此 ID 在 Relation 中找到对应的 API 信息。

GBFDCV8
MaxRunningTimeinteger

运行时长,单位分钟。

2
RelationLoadConfigListobject []

链路施压配置信息。

ConcurrencyBegininteger

起始并发。

10
ConcurrencyLimitinteger

最大并发。

20
RelationIdstring

链路 ID。

HNBGS7M
Configurationobject

全场景并发或 RPS 配置信息。

AllRpsBegininteger

起始 RPS。

100
AllConcurrencyBegininteger

起始并发。

100
AllConcurrencyLimitinteger

最大并发。

200
AllRpsLimitinteger

最大 RPS。

200
AgentCountinteger

施压机器。

1
TestModestring

施压模式。TPS 表示施压模式为 RPS 模式。

说明 该返回结果为 CONCURRENCY/TPS。
TPS
AutoStepboolean

是否为自动递增模式。

false
Incrementinteger

递增百分比,取值范围[10,100],且是整十倍。只有在并发模式且是自动递增模式下有效,即 testMode=concurrency_mode 且 autoStep=true 时。

10
KeepTimeinteger

单量级持续时长,单位分钟,一定是小于施压时长 maxRunningTime。

2
VpcLoadConfigobject

VPC 配置,VPC 压测模式下生效。

VpcIdstring

专有网络 ID。

vpc-akjhsdajgjsfggahjkga
VSwitchIdstring

虚拟交换机 ID。

vsw-skjfhlahsljkhsfalkjdoiw
SecurityGroupIdstring

安全组 ID。

sg-jkasgfieiajidsjakjscb
RegionIdstring

地域 ID。

cn-beijing
FileParameterListobject []

文件参数。

FileOssAddressstring

您自己的 OSS 文件地址,要求公网可访问。

https://test.oss-cn-shanghai.aliyuncs.com/json.jar
FileNamestring

文件名。

city.csv
ModifiedTimestring

最新修改时间。

2021-03-26 15:30:30
AdvanceSettingobject

高级设置。

LogRateinteger

日志采样率。

1
DomainBindingListobject []

域名和 IP 绑定关系。

Domainstring

域名。

www.aliyundoc.com
Ipsarray

绑定 IP。

string

绑定 IP。

[1.1.1.1]
ConnectionTimeoutInSecondinteger

场景超时时间,单位 s。

5
SuccessCodestring

自定义成功状态码。

429,304
CreateTimestring

创建时间。

2021-02-26 15:30:30
RelationListobject []

链路信息。

RelationNamestring

链路名。

下单链路
FileParameterExplainListobject []

文件参数说明。

CycleOnceboolean

是否循环一次。

true
FileParamNamestring

文件中的参数名。

userName,age
FileNamestring

文件名。

city.csv
BaseFileboolean

是否作为基准列。

true
ApiListobject []

API 信息。

ApiIdstring

API ID。可以根据此 ID 在 Relation 中找到对应的 API 信息。

GBFDCV8
CheckPointListobject []

所有检查点。

CheckTypestring

检查类型。

EXPORTED_PARAM
Operatorstring

比较符号。

ctn
ExpectValuestring

期望值。

111
CheckPointstring

检查点。

userId
HeaderListobject []

Header 信息。

HeaderValuestring

参数值。

1111
HeaderNamestring

参数名。

userId
TimeoutInSecondinteger

超时时间,单位秒。

5
ExportListobject []

所有导出参数。

ExportTypestring

导出参数来源。

BODY_JSON
ExportValuestring

解释表达式。

username
ExportNamestring

导出参数名。

data.username
Countstring

导出参数匹配项。

0
Urlstring

请求 URL。

https://www.aliyundoc.com
Methodstring

请求方法。

GET
Bodyobject

Body 内容。

BodyValuestring

Body 值。

{\"key1\":\"111\",\"key2\":\"222\"}
ContentTypestring

Body 类型。

application/x-www-form-urlencoded
RedirectCountLimitinteger

重定向次数。

5
ApiNamestring

API 名称。

下单
RelationIdstring

链路 ID。

HNBGS7M
SceneNamestring

场景名。

下单场景
SceneIdstring

场景 ID。

BGFJ7GV
GlobalParameterListobject []

全局参数。

ParamNamestring

参数名。

userName
ParamValuestring

参数值。

lisi
Headersobject []

场景所设置的全局 Header

Namestring

Header 的名称

key1
Valuestring

Header 的值

value1
Codestring

系统状态码。

200
Successboolean

是否成功。

  • true:成功
  • false:失败
true

示例

正常返回示例

JSON格式

{
  "Message": "空",
  "RequestId": "DC4E3177-6745-4925-B423-4E89VV34221A",
  "HttpStatusCode": 200,
  "Scene": {
    "Status": "Draft:草稿\nWaitStart:待启动\nDebugging:调试中\nRunning:运行中\n",
    "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",
      "AutoStep": false,
      "Increment": 10,
      "KeepTime": 2,
      "VpcLoadConfig": {
        "VpcId": "vpc-akjhsdajgjsfggahjkga",
        "VSwitchId": "vsw-skjfhlahsljkhsfalkjdoiw",
        "SecurityGroupId": "sg-jkasgfieiajidsjakjscb",
        "RegionId": "cn-beijing"
      }
    },
    "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"
      }
    ],
    "Headers": [
      {
        "Name": "key1",
        "Value": "value1"
      }
    ]
  },
  "Code": "200",
  "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错误码错误信息
400GetPtsSceneFailThe scene does not exit

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2021-12-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈