0. 版本说明

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

1. 简介

基于华为云Python SDK, 与前向流量池的相关操作

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_sim_pool_members_request import ListSimPoolMembersRequest
from huaweicloudsdkgsl.v3.model.list_sim_pools_request import ListSimPoolsRequest
from huaweicloudsdkgsl.v3.region.gsl_region import GslRegion

4.2.1 初始化认证信息

auth = BasicCredentials(
     ak=SimPoolApplication.__AK,
     sk=SimPoolApplication.__SK,
     ).with_iam_endpoint(endpoint=SimPoolApplication.__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. 示例代码

使用如下代码对前向流量池进行操作，调用前请根据实际情况替换变量：

class SimPoolApplication:
   # 认证用的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=SimPoolApplication.__AK,
         sk=SimPoolApplication.__SK,
      ).with_iam_endpoint(endpoint=SimPoolApplication.__IAM_ENDPOINT)

      gsl_client = GslClient.new_builder()
         .with_credentials(credentials=auth)
         .with_region(region=GslRegion.CN_NORTH_4)
         .build()
      # 查询流量池成员列表
      SimPoolApplication.__list_sim_pool_members(gsl_client)
      # 查询流量池列表
      SimPoolApplication.__list_sim_pools(gsl_client)

   @staticmethod
   def __list_sim_pool_members(gsl_client):
      sim_pool_id = 3639843601089537
      cid = "8986031746205479425"
      limit = 10
      offset = 1
      billing_cycle = "2021-08"
      try:
         response = gsl_client.list_sim_pool_members(
            ListSimPoolMembersRequest(
               sim_pool_id=sim_pool_id,
               limit=limit,
               offset=offset,
               cid=cid,
               billing_cycle=billing_cycle
            )
         )
         print(response)
      except exceptions.ClientRequestException as e:
         SimPoolApplication.__handle_exception(e)

   @staticmethod
   def __list_sim_pools(gsl_client):
      pool_name = "本地测试流量池"
      limit = 10
      offset = 1
      billing_cycle = "2022-04"
      try:
         response = gsl_client.list_sim_pools(
            ListSimPoolsRequest(
               billing_cycle=billing_cycle,
               limit=limit,
               offset=offset,
               pool_name=pool_name
            )
         )
         print(response)
      except exceptions.ClientRequestException as e:
         SimPoolApplication.__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__":
   SimPoolApplication().main(any)

6. 运行结果

调用list_sim_pools查询前向流量池列表，请求参数：

GET https://{endpoint}/v1/sim-pools?offset=1&limit=10

返回响应：

{
  "limit" : 10,
  "offset" : 1,
  "count" : 1,
  "pools" : [ {
    "id" : 1000000000,
    "pool_name" : "流量池名称",
    "price_plan_name" : "中国联通消费级每月30M联接服务（1年）",
    "price_plan_id" : "10000",
    "effective_time" : "2022-08-26T16:00:00.000+00:00",
    "expired_time" : "2022-09-26T15:59:59.000+00:00",
    "billing_cycle" : "2022-09",
    "flow_total" : 60,
    "flow_used" : 102.59,
    "flow_left" : -42.59,
    "quantity" : 100,
    "modify_time" : "2022-09-22T18:57:15.000+00:00",
    "order_id" : 100000000,
    "activated_sim_quantity" : 2,
    "inactive_sim_quantity" : 0,
    "disassembled_sim_quantity" : 98,
    "order_ids" : "1000000"
  } ]
}

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	更新文档