调用该接口获取用户已提交的网关元组工单列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListGatewayTupleOrders

系统规定参数。取值:ListGatewayTupleOrders

State.N String APPLYING

工单状态过滤列表,若不使用此参数,则表示查询所有状态的工单。可取值为:

  • APPLYING:申请中。
  • REJECTED:已拒绝。
  • ACCEPTING:分发中。
  • ACCEPTED:分发成功。
  • ACCEPTING_FAILED:分发失败。
  • REVOKING:撤回中。
  • REVOKED:撤回成功。
  • REVOKING_FAILED:撤回失败。
Offset Long 0

本次查询的起始位置,从0开始。

Limit Long 10

本次查询的工单数量上限,需大于等于1。

SortingField String CREATED_MILLIS

查询结果排序字段。可取值为:

  • CREATED_MILLIS:根据工单发起时间排序。
  • ACCEPTED_MILLIS:根据工单审批通过时间排序。
Ascending Boolean true

需配合SortingField参数一起使用。

  • true:表示升序。
  • false:表示降序。

返回数据

名称 类型 示例值 描述
Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。
RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

请求ID,阿里云为该请求生成的唯一标识符。

Data Object

返回的结果。

TotalCount Long 42

满足过滤条件的工单总数量。

List Array of GatewayTupleOrder

查询到的网关密钥工单信息列表。

RequiredCount Long 2

网关密钥颁发数量。

CreatedMillis Long 1514736000000

提交此工单的UNIX时间戳,单位为毫秒。

TupleType String standard

网关密钥类型。

  • singlechannel:低速版(单通道型)。
  • standard:标准版。
  • hybrid:高速版(Hybrid型)。
  • noncontractual:高速版。
AcceptedMillis Long 1514822400000

工单审批通过的UNIX时间戳,单位为毫秒。

OrderId String 1234

网关密钥订单编号。

OrderState String ACCEPTED

网关密钥申请状态。

示例

请求示例

http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=ListGatewayTupleOrders
&State=["APPLYING"]
&Offset=0
&Limit=10
&SortingField=CREATED_MILLIS
&Ascending=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListGatewayTupleOrdersResponse>
    <Success>true</Success>
    <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
    <Data>
        <TotalCount>42</TotalCount>
        <List>
            <RequiredCount>2</RequiredCount>
            <CreatedMillis>1514736000000</CreatedMillis>
            <TupleType>standard</TupleType>
            <AcceptedMillis>1514822400000</AcceptedMillis>
            <OrderId>1234</OrderId>
            <OrderState>ACCEPTED</OrderState>
        </List>
    </Data>
</ListGatewayTupleOrdersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
  "Data" : {
    "TotalCount" : 42,
    "List" : [ {
      "RequiredCount" : 2,
      "CreatedMillis" : 1514736000000,
      "TupleType" : "standard",
      "AcceptedMillis" : 1514822400000,
      "OrderId" : "1234",
      "OrderState" : "ACCEPTED"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 ForbiddenByRam User not authorized to operate on the specified resource, or this API does not support RAM. 用户没有执行该操作所需要的RAM权限。
400 ForbiddenByRiskControl This operation cannot be performed because of security risks. 存在安全风险,无法执行该操作
400 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
400 CloudProductNotActivated The Link WAN service has not been activated. 未开通 Link WAN 云产品
400 FeatureNotActivated The feature has not been activated. 功能未开通

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