0. 版本说明

本示例基于华为云Python SDK开发

1. 简介

基于华为云Python SDK, 批量查询实体卡流量和sim卡套餐列表查询

2. 开发前准备

已注册华为云, 并完成实名认证; 已获取华为云账号对应的Access Key（AK）和Secret Access Key(SK); 具备开发环境，支持Python3及以上版本

3. 安装SDK

您可以通过加入相应的依赖项获取和安装SDK。

安裝核心库：

pip install huaweicloudsdkcore

安装sdk：

pip install huaweicloudsdkgsl

4. 开始使用

4.1 导入依赖模块

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgsl.v3.gsl_client import GslClient
from huaweicloudsdkgsl.v3.model.list_flow_by_sim_cards_req import ListFlowBySimCardsReq
from huaweicloudsdkgsl.v3.model.list_flow_by_sim_cards_request import ListFlowBySimCardsRequest
from huaweicloudsdkgsl.v3.model.list_sim_price_plans_request import ListSimPricePlansRequest
from huaweicloudsdkgsl.v3.region.gsl_region import GslRegion

4.2.1 初始化认证信息

auth = BasicCredentials(
     ak=SimPricePlansApplication.__AK,
     sk=SimPricePlansApplication.__SK,
     ).with_iam_endpoint(endpoint=SimPricePlansApplication.__IAM_ENDPOINT)

__IAM_ENDPOINT: 华为云IAM服务访问终端地址,详情见https://developer.huaweicloud.com/endpoint?IAM

4.2.2 初始化客户端

gsl_client = GslClient.new_builder()
   .with_credentials(credentials=auth)
   .with_region(region=GslRegion.CN_NORTH_4)
   .build()

5. 示例代码

使用如下代码进行批量查询实体卡流量和sim卡套餐列表查询，调用前请根据实际情况替换变量：

class SimPricePlansApplication:
   # 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
   # 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
   __AK = os.environ["HUAWEICLOUD_SDK_AK"]
   __SK = os.environ["HUAWEICLOUD_SDK_SK"]

   # 华为云IAM服务访问终端地址
   __IAM_ENDPOINT = "https://<IamEndpoint>"

   def __init__(self):
      pass

   @staticmethod
   def main(args):
      # 创建认证
      auth = BasicCredentials(
         ak=SimPricePlansApplication.__AK,
         sk=SimPricePlansApplication.__SK,
      ).with_iam_endpoint(endpoint=SimPricePlansApplication.__IAM_ENDPOINT)

      gsl_client = GslClient.new_builder()
         .with_credentials(credentials=auth)
         .with_region(region=GslRegion.CN_NORTH_4)
         .build()
      # 批量查询实体卡流量
      SimPricePlansApplication.__list_flow_by_sim_cards(gsl_client)
      # sim卡套餐列表查询
      SimPricePlansApplication.__list_sim_price_plans(gsl_client)

   @staticmethod
   def __list_flow_by_sim_cards(gsl_client):
      iccids = []
      iccids.append("898602B4151880002907")
      iccids.append("89860317422045106999")
      iccids.append("898602B4151880002849")
      try:
         response = gsl_client.list_flow_by_sim_cards(
            ListFlowBySimCardsRequest(
               body=ListFlowBySimCardsReq(
                  iccids=iccids
               )
            )
         )
         print(response)
      except exceptions.ClientRequestException as e:
         SimPricePlansApplication.__handle_exception(e)

   @staticmethod
   def __list_sim_price_plans(gsl_client):
      sim_card_id = 13
      real_time = False
      limit = 10
      offset = 1
      try:
         response = gsl_client.list_sim_price_plans(
            ListSimPricePlansRequest(
               limit=limit,
               offset=offset,
               real_time=real_time,
               sim_card_id=sim_card_id
            )
         )
         print(response)
      except exceptions.ClientRequestException as e:
         SimPricePlansApplication.__handle_exception(e)

   @staticmethod
   def __handle_exception(e):
      print(e.status_code)
      print(e.request_id)
      print(e.error_code)
      print(e.error_msg)


if __name__ == "__main__":
   SimPricePlansApplication().main(any)

6. 运行结果

通过调用list_flow_by_sim_cards方法来查询sim卡的流量

POST https://{endpoint}/v1/sim-price-plans/usage/batch-query

{
  "iccids" : [ "898606xxxxxxxxxxxx", "898607xxxxxxxxxxxx" ]
}

接口响应：

[
   {
      "id": 100000000000,
      "account_id": "04eexxxxxxxxxx",
      "sim_card_id": 100000000000,
      "price_plan_id": "10001",
      "price_plan_name": "中国联通消费级每月30M联接服务（1年）",
      "iccid": "898606xxxxxxxxxxxx",
      "flow_total": 30,
      "flow_used": 0,
      "flow_left": 30
   },
   {
      "id": 100000000001,
      "account_id": "04eexxxxxxxxxx",
      "sim_card_id": 100000000001,
      "price_plan_id": "10001",
      "price_plan_name": "中国联通消费级每月30M联接服务（1年）",
      "iccid": "898607xxxxxxxxxxxx",
      "flow_total": 30,
      "flow_used": 0,
      "flow_left": 30
   }
]

7. 参考

更多信息请参考全球SIM联接 GSL

8. 修订记录

发布日期	文档版本	修订说明
2021-09-28	1.0.1	文档首次发布
2022-04-12	1.0.2	更新依赖，修改部分接口
2022-06-12	1.0.3	更新依赖，新增标签管理，自定义属性管理接口说明
2022-08-02	1.0.4	更新依赖
2023-11-08	1.0.5	更新文档