文档

ListBatchOperateCardsTasks - 列出批量操作卡任务

更新时间:
一键部署

列出批量操作卡任务。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 id。

cn-hangzhou
Statusesarray

批量操作任务的状态。

string

任务状态,取值:

  • Creating: 创建中
  • Pending: 待生效
  • Available: 全部成功
  • PartialAvailable: 部分成功
  • UnAvailable: 已失效
  • Fail: 全部失败
Creating
BatchOperateCardsTaskIdsarray

批量操作任务的 id 列表。

string

批量操作任务 id。

boct-xxxx
NextTokenstring

上一页的查询返回的值,首页查询不传值。

iou001238joojjaere
MaxResultslong

分页查询时每页的行数,最大值为 50,默认值为 10

10
Namesarray

批量操作的名称。

string
xxxx工厂实例批量限速

返回参数

名称类型描述示例值
object

响应对象

RequestIdstring

请求 id。

1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6
BatchOperateCardsTasksobject []

卡批量操作任务列表。

BatchOperateCardsTaskIdstring

批量操作任务 ID。

boct-xxxx
Statusstring

任务状态,取值:

  • Creating: 创建中
  • Pending: 待生效
  • Available: 全部成功
  • PartialAvailable: 部分成功
  • UnAvailable: 已失效
  • Fail: 全部失败
Available
OperateTypestring

限制类型,枚举值:

  • BreakNetwork: 达量断网
  • LimitRate: 达量限速
  • Alarm: 达量告警
BreakNetwork
Thresholdstring

达量阈值,单位 MB。

100
EffectTypestring

生效类型,枚举值:

  • CurrentMonth
  • ContinualMonth
CurrentMonth
IccidsOssFilePathstring

iccid 文件存放路径。

https://examplebucket.oss-eu-central-1.aliyuncs.com/***
WirelessCloudConnectorsobject []

5G 高速上云的实例 ID 和状态列表。

WirelessCloudConnectorIdstring

5G 高速上云实例 id。

cc5g-xxxx
Statusstring

状态,枚举值:

  • Creating: 创建中
  • Available: 有效的稳定状态
  • Pending: 配置中
  • Deleting: 删除中
  • Deleted: 已删除
Deleted
OperateResultOssFilePathstring

批量操作结果的文件路径。

https://examplebucket.oss-eu-central-1.aliyuncs.com/***
Descriptionstring

批量操作描述。

task-test
Namestring

批量操作名称。

test
CreateTimestring

创建时间。

2022-3-15 22:20:00
NextTokenstring

下一次查询的起始 token。

iou001238joojjaere
MaxResultsstring

分页查询时每页的行数,最大值为 50,默认值为 10

10
TotalCountstring

列表的条目数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "1651FBB6-4FBF-49FF-A9F5-DF5D696C7EC6",
  "BatchOperateCardsTasks": [
    {
      "BatchOperateCardsTaskId": "boct-xxxx",
      "Status": "Available",
      "OperateType": "BreakNetwork",
      "Threshold": "100",
      "EffectType": "CurrentMonth",
      "IccidsOssFilePath": "https://examplebucket.oss-eu-central-1.aliyuncs.com/***",
      "WirelessCloudConnectors": [
        {
          "WirelessCloudConnectorId": "cc5g-xxxx",
          "Status": "Deleted"
        }
      ],
      "OperateResultOssFilePath": "https://examplebucket.oss-eu-central-1.aliyuncs.com/***",
      "Description": "task-test",
      "Name": "test",
      "CreateTime": "2022-3-15 22:20:00"
    }
  ],
  "NextToken": "iou001238joojjaere",
  "MaxResults": "10",
  "TotalCount": "2"
}

错误码

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

  • 本页导读 (0)
文档反馈