获取用户已提交的网关元组工单列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListGatewayTupleOrders |
系统规定参数。取值:ListGatewayTupleOrders。 |
Limit | Long | 是 | 10 |
本次查询的工单数量上限,大于等于 1。 |
Offset | Long | 是 | 0 |
本次查询的起始位置,从 0 开始。 |
State.N | RepeatList | 否 | APPLYING |
工单状态过滤列表,若不使用此参数,则表示查询所有状态的工单 参考工单状态取值 |
SortingField | String | 否 | CREATED_MILLIS |
查询结果排序字段: 可取值为 CREATED_MILLIS(根据工单发起时间排序), ACCEPTED_MILLIS(根据工单审批通过时间排序)。 |
Ascending | Boolean | 否 | true |
配合 SortingField 参数一起使用,true 表示升序,false 表示降序 |
类型说明
工单状态取值
名称 |
类型 |
说明 |
---|---|---|
APPLYING |
String |
申请中。 |
REJECTED |
String |
已拒绝。 |
ACCEPTING |
String |
颁发中。 |
ACCEPTING_FAILED |
String |
颁发失败。 |
ACCEPTED |
String |
颁发成功。 |
REVOKING |
String |
撤回中。 |
REVOKING_FAILED |
String |
撤回失败。 |
REVOKED |
String |
撤回成功。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
返回的结果。 |
|
List | Array |
查询到的网关密钥工单信息列表。 |
|
AcceptedMillis | Long | 1514822400000 |
工单审批通过的 UNIX 时间戳,以毫秒为单位。 |
CreatedMillis | Long | 1514736000000 |
提交此工单的 UNIX 时间戳,以毫秒为单位。 |
OrderId | String | 1234 |
网关密钥订单编号。 |
OrderState | String | ACCEPTED |
网关密钥申请状态。 |
RequiredCount | Long | 2 |
网关密钥颁发数量。 |
TupleType | String | standard |
网关密钥类型 低速版(单通道型):singlechannel 标准版:standard 高速版(Hybrid型):hybrid 高速版:noncontractual |
TotalCount | Long | 42 |
满足过滤条件的工单总数量。 |
RequestId | String | 89EF6CAA-958F-F32C-BE45-FE003C6DE097 |
请求ID。 |
Success | Boolean | true |
是否成功。 |
示例
请求示例
https://linkwan.cn-shanghai.aliyuncs.com/
?Action=ListGatewayTupleOrders
&SortingField=CREATED_MILLIS
&State.1=ACCEPTED
&State.2=REJECTED
&Ascending=false
&Limit=2
&Offset=0
&<公共参数>
正常返回示例
XML
格式
<RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
<Success>true</Success>
<Data>
<TotalCount>42</TotalCount>
<List>
<OrderId>1234</OrderId>
<OrderState>ACCEPTED</OrderState>
<RequiredCount>1</RequiredCount>
<CreatedMillis>1514736000000</CreatedMillis>
<AcceptedMillis>1514822400000</AcceptedMillis>
<TupleType>noncontractual</TupleType>
</List>
<List>
<OrderId>1235</OrderId>
<OrderState>ACCEPTED</OrderState>
<RequiredCount>1</RequiredCount>
<CreatedMillis>1514736000000</CreatedMillis>
<AcceptedMillis>1514822400000</AcceptedMillis>
<TupleType>noncontractual</TupleType>
</List>
</Data>
JSON
格式
{
"RequestId": "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
"Success": true,
"Data": {
"TotalCount": 42,
"List": [
{
"OrderId": 1234,
"OrderState": "ACCEPTED",
"RequiredCount": 1,
"CreatedMillis": 1514736000000,
"AcceptedMillis": 1514822400000,
"TupleType":"noncontractual"
},
{
"OrderId": 1235,
"OrderState": "ACCEPTED",
"RequiredCount": 1,
"CreatedMillis": 1514736000000,
"AcceptedMillis": 1514822400000,
"TupleType":"noncontractual"
}
]
}
}
错误码
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. | 功能未开通 |
访问错误中心查看更多错误码。