华为云用户手册

  • URI GET /v1/back-pools/{back_pool_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 back_pool_id 是 Long 流量池标识 最小值:0 表2 Query参数 参数 是否必选 参数类型 描述 cid 否 String 容器ID limit 否 Long 每页记录数 最小值:10 最大值:500 缺省值:10 offset 否 Long 页码 最小值:1 最大值:1000000 缺省值:1 billing_cycle 是 String 账期,例如:2021-04 最小长度:7 最大长度:7
  • 响应示例 状态码: 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "pools" : [ { "id" : 10000000001, "pool_name" : "流量池名称", "price_plan_name" : "中国电信消费级阶梯流量池联接服务", "price_plan_id" : "520040", "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_used" : 102.59, "quantity" : 100, "pool_status" : 2, "modify_time" : "2022-09-22T18:57:15.000+00:00", "activated_sim_quantity" : 2, "inactive_sim_quantity" : 0, "disassembled_sim_quantity" : 98, "order_id" : 111111111, "order_ids" : "1000000" } ]} 状态码: 400 Bad Request { "error_code" : "GSL.00010004", "error_msg" : "参数异常"} 状态码: 403 Forbidden { "error_code" : "GSL.00011004", "error_msg" : "账期不合法,请检查!"} 状态码: 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙,请稍后重试。"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前查询条件的后向流量池总数 pools Array of BackPoolVO objects 当前页的后向流量池记录列表 表4 BackPoolVO 参数 参数类型 描述 id Long 流量池标识 pool_name String 流量池名称 最大长度:100 price_plan_name String 套餐名称 最大长度:128 price_plan_id String 套餐标识 最大长度:36 effective_time String 生效时间 expired_time String 失效时间 billing_cycle String 账期 最大长度:7 pool_status Integer 流量池状态: 2-在用,-1-已停用,-2已废弃 flow_used Double 已用流量(查询账期所在月份), 单位MB 最小值:0 status_time String 状态变更时间 quantity Integer 流量池成员数量 modify_time String 更新时间 order_id Long 批次号 activated_sim_quantity Integer 已激活成员数量 inactive_sim_quantity Integer 未激活成员数量 disassembled_sim_quantity Integer 已拆机成员数量 order_ids String 组成流量池的批次号列表 最大长度:400 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • URI GET /v1/back-pools 表1 Query参数 参数 是否必选 参数类型 描述 pool_name 否 String 流量池名称 最大长度:100 limit 否 Long 分页查询时每页显示的记录数,默认值为10,取值范围为10-500的整数 最小值:10 最大值:500 缺省值:10 offset 否 Long 分页查询时的页码数,默认值为1,取值范围为1-1000000的整数 最小值:1 最大值:1000000 缺省值:1 billing_cycle 否 String 账期,例如:2021-04 最小长度:7 最大长度:7 all_billing_cycle 否 Boolean 是否查询近六个月账期标识 缺省值:false
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 speed_value 是 Integer 限制带宽速率,单位 Kbps,-1表示不限速,1Mbps=1024Kbps。正整数表示限制到当前速率,电信支持限制速率:1Kbps,64 Kbps,256 Kbps,512Kbps,1Mbs,3Mbs,5Mbs,7Mbs,10Mbs,20Mbs,30Mbs,40Mbs,50Mbs,60Mbs,70Mbs,80Mbs,90Mbs,100Mbs,110Mbs,120Mbs,130Mbs,140Mbs,150Mbs。联通支持限制速率:256Kbps,512Kbps,1Mbps,2Mbps,7.25Mbps。 最小值:-1
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "work_order_id" : 1000001} 状态码: 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码: 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "work_order_id" : 1000001} 状态码: 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码: 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 bind_type 是 Integer 绑定类型(1:普通机卡重绑,2:固定机卡重绑) 最小值:1 最大值:2 imei 否 String 设备IMEI,84584xxxxxx
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "work_order_id" : 1000001} 状态码: 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码: 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。"}
  • 响应示例 状态码: 200 OK { "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" } ]} 状态码: 400 Bad Request { "code" : "GSL.00010004", "message" : "参数异常"} 状态码: 403 Forbidden { "code" : "GSL.00011004", "message" : "账期不合法,请检查!"} 状态码: 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。"}
  • URI GET /v1/sim-pools 表1 Query参数 参数 是否必选 参数类型 描述 pool_name 否 String 流量池名称 最大长度:100 limit 否 Long 分页查询时每页显示的记录数,默认值为10,取值范围为10-500的整数 最小值:10 最大值:500 缺省值:10 offset 否 Long 分页查询时的页码数,默认值为1,取值范围为1-1000000的整数 最小值:1 最大值:1000000 缺省值:1 billing_cycle 否 String 账期,例如:2021-04 最小长度:7 最大长度:7 all_billing_cycle 否 Boolean 是否查询近六个月账期标识 缺省值:false
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前查询条件的流量池总数 pools Array of SimPoolVO objects 当前页的流量池记录列表 表4 SimPoolVO 参数 参数类型 描述 id Long 流量池标识 pool_name String 流量池名称 最大长度:100 price_plan_name String 套餐名称 最大长度:128 price_plan_id String 套餐标识 最大长度:36 effective_time String 生效时间 expired_time String 失效时间 billing_cycle String 账期 最大长度:7 flow_total Double 可用流量(查询账期所在月份),单位MB 最小值:0 flow_used Double 已用流量(查询账期所在月份), 单位MB 最小值:0 flow_left Double 剩余流量(查询账期所在月份), 单位MB 最小值:0 quantity Integer 流量池成员数量 modify_time String 更新时间 order_id Long 批次号 activated_sim_quantity Integer 已激活成员数量 inactive_sim_quantity Integer 未激活成员数量 disassembled_sim_quantity Integer 已拆机成员数量 order_ids String 组成流量池的批次号列表 最大长度:400 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "work_order_id" : 1000001} 状态码: 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码: 403 Forbidden { "code" : "GSL.00016015", "message" : "您操作的卡仍有未完成的激活受理单,请勿重复操作。"} 状态码: 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。"}
  • 响应示例 状态码: 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常"} 示例 2 { "error_code" : "GSL.00022001", "error_msg" : "标签名称不合法,请检查!"} 示例 3 { "error_code" : "GSL.00022002", "error_msg" : "标签名称已存在,请重新输入!"} 示例 4 { "error_code" : "GSL.00022003", "error_msg" : "登录用户最多可以创建10000个标签。"} 示例 5 { "error_code" : "GSL.00022004", "error_msg" : "登录用户没有标签的访问权限。"} 状态码: 500 Internal Server Error { "code" : "GSL.00020003", "message" : "系统繁忙,请稍后重试。"}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 id Long 标签标识 tag_name String 标签名称 最大长度:100 status Integer 标签状态,0未使用,1使用中。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512
  • 响应示例 状态码: 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常"} 示例 2 { "error_code" : "GSL.00022004", "error_msg" : "登录用户没有标签的访问权限。"} 状态码: 500 Internal Server Error { "code" : "GSL.00020003", "message" : "系统繁忙,请稍后重试。"}
  • 子网(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询子网列表 GET /v2.0/subnets vpc:subnets:get √ × 查询子网 GET /v2.0/subnets/{subnet_id} vpc:subnets:get √ × 创建子网 POST /v2.0/subnets vpc:subnets:create √ × 更新子网 PUT /v2.0/subnets/{subnet_id} vpc:subnets:update √ × 删除子网 DELETE /v2.0/subnets/{subnet_id} vpc:subnets:delete √ × 父主题: 权限和授权项
  • 安全组(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询安全组 GET /v2.0/security-groups vpc:securityGroups:get √ × 查询安全组详情 GET /v2.0/security-groups/{security_group_id} vpc:securityGroups:get √ × 创建安全组 POST /v2.0/security-groups vpc:securityGroups:create √ × 更新安全组 PUT /v2.0/security-groups/{security_group_id} vpc:securityGroups:update √ × 删除安全组 DELETE /v2.0/security-groups/{security_group_id} vpc:securityGroups:delete √ × 查询安全组规则 GET /v2.0/security-group-rules vpc:securityGroupRules:get √ × 查询安全组规则详情 GET /v2.0/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:get √ × 创建安全组规则 POST /v2.0/security-group-rules vpc:securityGroupRules:create √ × 删除安全组规则 DELETE /v2.0/security-group-rules/{rules_security_groups_id} vpc:securityGroupRules:delete √ × 父主题: 权限和授权项
  • 子网标签 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建子网资源标签 POST /v2.0/{project_id}/subnets/{subnet_id}/tags vpc:subnetTags:create √ × 查询子网资源标签 GET /v2.0/{project_id}/subnets/{subnet_id}/tags vpc:subnetTags:get √ × 删除子网资源标签 DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} vpc:subnetTags:delete √ × 批量创建和删除子网资源标签 POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action vpc:subnetTags:create vpc:subnetTags:delete √ × 查询子网资源实例 POST /v2.0/{project_id}/subnets/resource_instances/action vpc:subnetTags:get √ × 查询子网项目标签 GET /v2.0/{project_id}/subnets/tags vpc:subnetTags:get √ × 父主题: 权限和授权项
  • 网络(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询网络列表 GET /v2.0/networks vpc:networks:get √ × 查询网络 GET /v2.0/networks/{network_id} vpc:networks:get √ × 创建网络 POST /v2.0/networks vpc:networks:create √ × 更新网络 PUT /v2.0/networks/{network_id} vpc:networks:update √ × 删除网络 DELETE /v2.0/networks/{network_id} vpc:networks:delete √ × 父主题: 权限和授权项
  • 端口(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询端口列表 GET /v2.0/ports vpc:ports:get √ × 查询端口 GET /v2.0/ports/{port_id} vpc:ports:get √ × 创建端口 POST /v2.0/ports vpc:ports:create √ × 更新端口 PUT /v2.0/ports/{port_id} vpc:ports:update √ × 删除端口 DELETE /v2.0/ports/{port_id} vpc:ports:delete √ × 父主题: 权限和授权项
  • 响应参数 表4 响应参数 参数名称 类型 说明 peering peering object peering对象,参见表5。 表5 peering对象 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位: PENDING_ACCEPTANCE:等待接受 REJECTED:已拒绝。 EXPIRED:已过期。 DELETED:已删除。 ACTIVE:活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息,请参见表6。 accept_vpc_info vpc_info object 对等连接接受端vpc信息,请参见表6。 description String 对等连接描述 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表6 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id
  • 请求参数 表2 请求参数 参数名称 是否必选 类型 说明 peering 是 peering object peering对象中要更新的字段,请参见表3。 更新操作时至少指定一项属性,目前只支持更新name和description。 表3 对等连接更新字段说明 参数名称 是否必选 类型 说明 name 否 String 对等连接名称,支持长度为1-64字符 description 否 String 对等连接描述,取值范围:0-255个字符,支持数字、字母、中文字符
  • 响应示例 { "peering": { "name": "test2", "description": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "059a737356594b41b447b557bf0aae56" }, "status": "ACTIVE" }}
  • 对等连接 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询对等连接列表 GET /v2.0/vpc/peerings vpc:peerings:get √ × 查询对等连接 GET /v2.0/vpc/peerings/{peering_id} vpc:peerings:get √ × 创建对等连接 POST /v2.0/vpc/peerings vpc:peerings:create √ × 接受对等连接请求 PUT /v2.0/vpc/peerings/{peering_id}/accept vpc:peerings:accept √ × 拒绝对等连接请求 PUT /v2.0/vpc/peerings/{peering_id}/reject vpc:peerings:reject √ × 更新对等连接 PUT /v2.0/vpc/peerings/{peering_id} vpc:peerings:update √ × 删除对等连接 DELETE /v2.0/vpc/peerings/{peering_id} vpc:peerings:delete √ × 父主题: 权限和授权项
  • 安全组 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建安全组 POST /v1/{project_id}/security-groups vpc:securityGroups:create √ √ 创建安全组(v3) POST /v3/{project_id}/vpc/security-groups vpc:securityGroups:create √ √ 查询安全组 GET /v1/{project_id}/security-groups/{security_group_id} vpc:securityGroups:get √ √ 查询安全组(v3) GET /v3/{project_id}/vpc/security-groups/{security_group_id} vpc:securityGroups:get √ √ 查询安全组列表 GET /v1/{project_id}/security-groups vpc:securityGroups:get √ √ 查询安全组列表(v3) GET /v3/{project_id}/vpc/security-groups vpc:securityGroups:get √ √ 更新安全组(v3) PUT /v3/{project_id}/vpc/security-groups/{security_group_id} vpc:securityGroups:update √ √ 删除安全组 DELETE /v1/{project_id}/security-groups/{security_group_id} vpc:securityGroups:delete √ √ 删除安全组(v3) DELETE /v3/{project_id}/vpc/security-groups/{security_group_id} vpc:securityGroups:delete √ √ 父主题: 权限和授权项
共100000条