华为云用户手册

  • URI GET /v3/{domain_id}/ccaas/inter-region-bandwidths 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 Array 根据ID过滤域间带宽实例列表。 enterprise_project_id 否 Array 根据企业项目ID过滤域间带宽实例列表。 cloud_connection_id 否 Array 根据云连接ID过滤域间带宽实例列表。 bandwidth_package_id 否 Array 根据带宽包列表过滤域间带宽实例列表。
  • 响应示例 状态码: 200 查询域间带宽实例列表成功。 { "request_id" : "fd403735e22a5213845afbf69425a976", "inter_region_bandwidths" : [ { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2022-12-08T11:41:53Z", "updated_at" : "2022-12-08T11:41:53Z", "bandwidth_package_id" : "XXX", "cloud_connection_id" : "XXX", "bandwidth" : 5, "inter_regions" : [ { "id" : "XXX", "project_id" : "", "local_region_id" : "region_a", "remote_region_id" : "region_b" }, { "id" : "XXX", "project_id" : "", "local_region_id" : "region_b", "remote_region_id" : "region_a" } ] } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 1 }}
  • 响应示例 状态码: 200 查询网络实例列表成功。 { "request_id" : "b961d5fcda6b993b5b750f1b96e484e0", "network_instances" : [ { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2022-06-24T09:33:15Z", "updated_at" : "2022-06-24T09:33:16Z", "project_id" : "XXX", "instance_domain_id" : "", "cloud_connection_id" : "XXX", "region_id" : "br-iaas-odin1", "type" : "vpc", "instance_id" : "XXX", "cidrs" : [ "192.168.1.0/24" ], "status" : "ACTIVE" } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 1 }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 network_instances Array of NetworkInstance objects 网络实例列表。 page_info PageInfo object 分页查询页的信息。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 NetworkInstance 参数 参数类型 描述 id String 网络实例的ID。 最小长度:0 最大长度:36 name String 网络实例的名字。 最小长度:0 最大长度:64 description String 网络实例的描述。 最小长度:0 最大长度:85 domain_id String 帐号ID。 最小长度:10 最大长度:32 status String 网络实例的状态。 ACTIVE:处理成功。 PENDING:处理中。 ERROR:处理失败。 最小长度:0 最大长度:36 created_at String 网络实例的创建时间。 UTC时间格式,yyyy-MM-ddTHH:mm:ss updated_at String 网络实例的更新时间。 UTC时间格式,yyyy-MM-ddTHH:mm:ss type String 网络实例的类型。 vpc:虚拟私有云。 vgw:虚拟网关。 最小长度:0 最大长度:36 cloud_connection_id String 云连接实例ID。 最小长度:0 最大长度:36 instance_id String 网络实例的ID。 最小长度:0 最大长度:36 instance_domain_id String 网络实例所属账户ID。 最小长度:0 最大长度:36 region_id String 网络实例所在Region的ID。 最小长度:0 最大长度:36 project_id String 网络实例所在租户的项目ID。 最小长度:0 最大长度:36 cidrs Array of strings 网络实例发布的网段路由列表。 最小长度:0 最大长度:64 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页。 最小长度:0 最大长度:36 previous_marker String 上一页的marker,值为资源的uuid,为空时表示第一页。 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量。 最小值:0 最大值:2000
  • URI GET /v3/{domain_id}/ccaas/network-instances 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 Array 根据ID过滤网络实例列表。 name 否 Array 根据名称过滤网络实例列表。 description 否 Array 根据描述过滤网络实例列表。 status 否 Array 根据状态过滤网络实例列表。ACTIVE:表示状态可用。 缺省值:ACTIVE type 否 Array 根据类型过滤网络实例列表。 cloud_connection_id 否 Array 根据云连接实例ID过滤网络实例列表。 instance_id 否 Array 根据网络实例ID过滤网络实例列表。 region_id 否 Array 根据网络实例所在的Region过滤网络实例列表。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 quotas Array of Quota objects 配额列表。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 Quota 参数 参数类型 描述 domain_id String 账号ID。 最小长度:10 最大长度:32 quota_type String 配额类型: cloud_connection: 可加载的云连接实例数 cloud_connection_region: 某云连接实例下可加载的Region数 cloud_connection_route: 某云连接实例下可加载的路由数 region_network_instance: 某云连接实例下某个Region下可加载的网络实例数 quota_number Integer 配额数量。 最小值:0 最大值:102400 quota_used Integer 配额使用数量。 最小值:0 最大值:102400 cloud_connection_id String 云连接ID。 最小长度:0 最大长度:36 region_id String 网络实例的RegionID。 最小长度:0 最大长度:36
  • URI GET /v3/{domain_id}/ccaas/quotas 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 quota_type 是 String 配额类型: cloud_connection: 可加载的云连接实例数 cloud_connection_region: 某云连接实例下可加载的Region数 cloud_connection_route: 某云连接实例下可加载的路由数 region_network_instance: 某云连接实例下某个Region下可加载的网络实例数 最小长度:0 最大长度:36
  • URI GET /v3/{domain_id}/ccaas/cloud-connections 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 Array 根据ID过滤云连接实例列表。 name 否 Array 根据名称过滤云连接实例列表。 description 否 Array 根据描述过滤云连接实例列表。 status 否 Array 根据状态过滤云连接实例列表。ACTIVE:表示状态可用。 缺省值:ACTIVE enterprise_project_id 否 Array 根据企业项目ID过滤云连接实例列表。 type 否 Array 根据类型过滤云连接实例列表。 used_scene 否 Array 根据使用场景过滤云连接实例列表。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 cloud_connections Array of CloudConnection objects 云连接实例列表。 page_info PageInfo object 分页查询页的信息。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 CloudConnection 参数 参数类型 描述 id String 云连接实例的ID。 最小长度:0 最大长度:36 name String 云连接实例的名字。 最小长度:1 最大长度:64 description String 云连接实例的描述。 最小长度:0 最大长度:255 domain_id String 帐号ID。 最小长度:10 最大长度:32 enterprise_project_id String 云连接实例的企业项目ID。 缺省值:0 最小长度:0 最大长度:36 status String 云连接实例的状态。ACTIVE:表示状态可用。 最小长度:0 最大长度:36 admin_state_up Boolean 云连接实例的管理状态。 created_at String 云连接实例的创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss updated_at String 云连接实例的更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss used_scene String 云连接使用场景。 VPC:虚拟私有云。 缺省值:vpc 最小长度:0 最大长度:36 tags Array of Tag objects 标签列表。 network_instance_number Integer 云连接实例关联网络实例的个数。 最小值:0 最大值:10000 bandwidth_package_number Integer 云连接实例关联带宽包的个数。 最小值:0 最大值:10000 inter_region_bandwidth_number Integer 云连接实例关联域间带宽的个数。 最小值:0 最大值:10000 表6 Tag 参数 参数类型 描述 key String 键 最小长度:1 最大长度:128 value String 值 最小长度:0 最大长度:255 表7 PageInfo 参数 参数类型 描述 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页。 最小长度:0 最大长度:36 previous_marker String 上一页的marker,值为资源的uuid,为空时表示第一页。 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量。 最小值:0 最大值:2000
  • 响应示例 状态码: 200 查询云连接实例列表成功。 { "request_id" : "ab44eb7776995d84a7580fe6a7bd7629", "cloud_connections" : [ { "status" : "ACTIVE", "id" : "XXX", "name" : "test", "description" : "", "domain_id" : "XXX", "created_at" : "2022-06-24T08:28:28Z", "updated_at" : "2022-06-24T08:28:28Z", "admin_state_up" : true, "used_scene" : "vpc", "enterprise_project_id" : "0", "network_instance_number" : 0, "bandwidth_package_number" : 0, "inter_region_bandwidth_number" : 0 } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 30 }}
  • 响应示例 状态码: 200 查询带宽包实例列表成功。 { "request_id" : "61126320a1802d5c6444f9d2d76526c2", "bandwidth_packages" : [ { "bandwidth" : 5, "status" : "ACTIVE", "id" : "XXXXX", "name" : "test_bwp_name", "description" : "", "domain_id" : "XXX", "created_at" : "2022-12-06T01:37:15Z", "updated_at" : "2022-12-06T01:37:15Z", "project_id" : "XXX", "resource_type" : "", "resource_id" : "", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "admin_state_up" : true, "charge_mode" : "bandwidth", "billing_mode" : "3", "spec_code" : "bandwidth.cmtocm", "order_id" : "", "product_id" : "", "enterprise_project_id" : "0", "tags" : [ ], "interflow_mode" : "Area" } ], "page_info" : { "next_marker" : "XXX", "previous_marker" : "XXX", "current_count" : 1 }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 bandwidth_packages Array of BandwidthPackage objects 带宽包实例列表。 page_info PageInfo object 分页查询页的信息。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 BandwidthPackage 参数 参数类型 描述 id String 带宽包实例的ID。 最小长度:0 最大长度:36 name String 带宽包实例的名字。 最小长度:1 最大长度:64 description String 带宽包实例的描述。 最小长度:0 最大长度:85 domain_id String 帐号ID。 最小长度:0 最大长度:36 enterprise_project_id String 带宽包实例的企业项目ID。 缺省值:0 最小长度:0 最大长度:36 status String 带宽包实例的状态。ACTIVE表示状态 最小长度:0 最大长度:36 created_at String 带宽包实例的创建时间。 updated_at String 带宽包实例的更新时间。 admin_state_up Boolean 带宽包实例的管理状态。 order_id String 带宽包实例的订单ID。 最小长度:0 最大长度:32 product_id String 带宽包实例的产品ID。 最小长度:0 最大长度:36 spec_code String 带宽包实例的规格编码。 bandwidth.aftoela:大陆站+国际站南非-拉美东 bandwidth.aftonla:大陆站+国际站南非-拉美北 bandwidth.aftowla:大陆站+国际站南非-拉美西 bandwidth.aptoaf:国际站亚太-南非 bandwidth.aptoap:国际站亚太-亚太 bandwidth.aptoela:大陆站+国际站亚太-拉美东 bandwidth.aptonla:大陆站+国际站亚太-拉美北 bandwidth.aptowla:大陆站+国际站亚太-拉美西 bandwidth.cmtoaf:国际站中国大陆-南非 bandwidth.cmtoap:国际站中国大陆-亚太 bandwidth.cmtocm:国际站中国大陆-中国大陆 bandwidth.cmtoela:大陆站+国际站中国大陆-拉美东 bandwidth.cmtonla:大陆站+国际站中国大陆-拉美北 bandwidth.cmtowla:大陆站+国际站中国大陆-拉美西 bandwidth.elatoela:大陆站+国际站拉美东-拉美东 bandwidth.elatonla:大陆站+国际站拉美东-拉美北 bandwidth.wlatoela:大陆站+国际站拉美西-拉美东 bandwidth.wlatonla:大陆站+国际站拉美西-拉美北 bandwidth.wlatowla:大陆站+国际站拉美西-拉美西 最小长度:0 最大长度:32 billing_mode String 带宽包实例在大陆站或国际站的计费方式。 1:大陆站包周期 2:国际站包周期 3:大陆站按需计费 4:国际站按需计费 5:大陆站按95方式计费 6:国际站按95方式计费 charge_mode String 带宽包实例的计费方式。 bandwidth是按带宽计费。 最小长度:0 最大长度:64 bandwidth Integer 带宽包实例中的带宽值。 最小值:2 最大值:999999 resource_id String 带宽包实例绑定的资源ID。 最小长度:0 最大长度:36 resource_type String 带宽包实例绑定的资源类型。 cloud_connection: 云连接实例。 最小长度:0 最大长度:32 local_area_id String 本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:32 remote_area_id String 远端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:32 project_id String 项目ID。 最小长度:0 最大长度:36 interflow_mode String 互通类型: Area: 大区互通 Region: 城域互通 最小长度:0 最大长度:32 tags Array of Tag objects 标签列表。 表6 Tag 参数 参数类型 描述 key String 键 最小长度:1 最大长度:128 value String 值 最小长度:0 最大长度:255 表7 PageInfo 参数 参数类型 描述 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页。 最小长度:0 最大长度:36 previous_marker String 上一页的marker,值为资源的uuid,为空时表示第一页。 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量。 最小值:0 最大值:2000
  • URI GET /v3/{domain_id}/ccaas/bandwidth-packages 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 Array 根据ID过滤带宽包实例列表。 name 否 Array 根据名称过滤带宽包实例列表。 status 否 Array 根据状态过滤带宽包实例列表。ACTIVE:表示状态可用。 缺省值:ACTIVE enterprise_project_id 否 Array 根据企业项目ID过滤带宽包实例列表。 billing_mode 否 Array 根据计费方式过滤带宽包实例列表。 resource_id 否 Array 根据绑定的资源ID过滤带宽包实例列表。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of AggTag objects 标签列表 request_id String 请求ID。 最小长度:0 最大长度:36 表4 AggTag 参数 参数类型 描述 key String 键 最小长度:1 最大长度:128 values Array of strings 相同键的值列表 最小长度:0 最大长度:255
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 CC.1001 The parameter is invalid. 入参非法。 请输入合法的参数。 400 CC.1006 Tenants are restricted and cannot operate APIs such as adding or modifying resources. 账户受限。 请联系技术支持。 400 CC.1007 Internal Server Error. 调用API出现异常。 请联系技术支持。 400 CC.1031 The cloud connection name already in use. 云连接名称重复。 请更换云连接名称。 400 CC.1032 The cloud connection cannot be deleted because it has network instances. 云连接下有实例,不能删除。 请先移除云连接下网络实例再执行删除云连接操作。 400 CC.1033 The cloud connection quota is insufficient. 云连接配额不足。 请联系技术支持。 400 CC.1041 Internal Server Error. 内部未知异常。 请联系技术支持。 400 CC.1042 The cloud connection instance is frozen. 云连接被冻结。 请联系技术支持。 400 CC.1043 ER type cloud connection is not supported. 不支持ER类型云连接。 请联系技术支持。 400 CC.1050 Please wait for approval. 跨境申请未通过。 请检查跨境申请审批状态。 400 CC.1051 No application for cross-border. 未提交跨境申请。 请先提交跨境申请。 400 CC.1052 The bandwidth package used in regionBandwidth cannot be deleted. 带宽包被域间带宽使用。 请先删除域间带宽,再删除带宽包。 400 CC.1053 The bandwidth package name is already in use. 带宽包名称不唯一。 请更换带宽包名称。 400 CC.1054 The bandwidth package is frozen. 冻结的带宽包不允许操作。 请联系技术支持。 400 CC.1055 The bandwidth package has been bound. 带宽包已经被绑定。 请检查输入的带宽包信息。 400 CC.1056 Used RegionBandwidth is bigger than new BwpSize. 带宽值不能小于被使用的带宽。 请检查带宽包已经被使用的带宽值。 400 CC.1057 The account does not have the permission to operation. 未加入白名单。 请联系技术支持。 400 CC.1061 Failed to delete the bandwidth package persistence. 带宽包删除返回值错误。 请联系技术支持。 400 CC.1062 Failed to update the bandwidth package persistence. 带宽包更新返回值错误。 请联系技术支持。 400 CC.1070 Same-direction instance is existed in cloud connection. 云连接中存在同一方向实例。 请检查云连接中网络实例信息。 400 CC.1071 Region Bandwidth Size is greater than bandwidth package size. 域间带宽大小大于带宽包大小。 请调小域间带宽值,或者升配带宽包。 400 CC.1072 ER type cloud connection does not support 95-billed bandwidth packages. ER类型云连接不支持95计费带宽包。 ER类型云连接请绑定其他类型的带宽包。 400 CC.1081 Internal Server Error. 内部未知异常。 请联系技术支持。 400 CC.1090 The instance has been used. 网络实例已经被加载。 请使用其他网络实例进行加载。 400 CC.1091 The CIDR of a network instance under the same cloud connection is unique. 同一个云连接下的网络实例CIDR唯一。 请使用不同的CIDR。 400 CC.1092 The instance is not authorized. 跨账号场景下网络实例未授权不允许加载。 请检查网络实例跨账号授权情况。 400 CC.1093 The network instance routing conflict. 前VPC存在路由冲突,此VPC路由已经在对等连接、VPN等其它场景中使用。 请检查路由冲突。 400 CC.1094 The ER instance status is not available. ER实例状态有异常。 请检查ER实例状态。 400 CC.1095 The ER attachment status not available. 加载ER实例时,重复创建了Attachment。 请联系技术支持。 400 CC.1096 The ER attachment quota is insufficient. 加载ER实例时,Attachment配额不足。 请联系技术支持。 400 CC.1110 Cross account authorization does not support cloud connection instances of this account. 跨账号授权不支持本账号云连接实例。 请检查授权的云连接实例信息。 400 CC.1111 The network instance has been authorized. 网络实例已被授权。 请检查授权的网络实例信息。 400 CC.1171 Related bandwidth package is not available. 相关带宽包不可用。 请联系技术支持。 400 CC.1250 If an enterprise project has been enabled you need to specify the enterprise project when creating resources. 企业项目为空。 请在创建资源时指定企业项目。 400 CC.1269 To create a resource in an enterprise project,you need to apply it first. 企业项目不为空。 请不要在创建资源时指定企业项目。 400 CC.1290 The cloud connection quota is insufficient. 云连接实例配额不足。 请联系技术支持。 400 CC.1291 No quotas for instance for this region. 云连接实例下单Region可加载网络实例配额不足。 请联系技术支持。 400 CC.1292 No quotas for region for this cloudconnect. 云连接实例下可加载Region配额不足。 请联系技术支持。 400 CC.1293 No quotas for route for this cloudconnect. 云连接实例下可加载路由配额不足。 请联系技术支持。 400 CC.1380 The resource processing, please try again later. 处理中,请稍后重试。 请稍后重试。 400 CC.1390 Domain Common Data Consent unable to operate non-Chinese mainland region. 您还未签署云连接服务声明,无法操作非中国大陆Region的资源。 请前往云连接控制台列表页面进行签署。 401 CC.1003 The parameter of domainId is illegal. 账户非法。 请检查租户ID的合法性。 403 CC.1004 You do not have permission to operate. 禁止访问。 请联系技术支持。 404 CC.1002 The resource could not be found. 未找到资源。 请输入正确的资源信息。 409 CC.1005 The resource already exists. 资源已存在。 请勿重复创建。 500 CC.1000 Internal Server Error. 内部未知异常。 请联系技术支持。 500 CC.1251 Internal Server Error. 内部未知异常。 请联系技术支持。 父主题: 附录
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_package 是 DisassociateBandwidthPackage object 解关联带宽包实例的详细信息。 表4 DisassociateBandwidthPackage 参数 是否必选 参数类型 描述 resource_id 是 String 带宽包实例待解关联的资源实例ID。 最小长度:0 最大长度:36 resource_type 是 String 带宽包实例待解关联的资源实例类型,cloud_connection:表示为云连接实例。 最小长度:0 最大长度:36
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 bandwidth_package BandwidthPackage object 带宽包实例。 request_id String 请求ID。 最小长度:0 最大长度:36 表6 BandwidthPackage 参数 参数类型 描述 id String 带宽包实例的ID。 最小长度:0 最大长度:36 name String 带宽包实例的名字。 最小长度:1 最大长度:64 description String 带宽包实例的描述。 最小长度:0 最大长度:85 domain_id String 帐号ID。 最小长度:0 最大长度:36 enterprise_project_id String 带宽包实例的企业项目ID。 缺省值:0 最小长度:0 最大长度:36 status String 带宽包实例的状态。ACTIVE表示状态 最小长度:0 最大长度:36 created_at String 带宽包实例的创建时间。 updated_at String 带宽包实例的更新时间。 admin_state_up Boolean 带宽包实例的管理状态。 order_id String 带宽包实例的订单ID。 最小长度:0 最大长度:32 product_id String 带宽包实例的产品ID。 最小长度:0 最大长度:36 spec_code String 带宽包实例的规格编码。 bandwidth.aftoela:大陆站+国际站南非-拉美东 bandwidth.aftonla:大陆站+国际站南非-拉美北 bandwidth.aftowla:大陆站+国际站南非-拉美西 bandwidth.aptoaf:国际站亚太-南非 bandwidth.aptoap:国际站亚太-亚太 bandwidth.aptoela:大陆站+国际站亚太-拉美东 bandwidth.aptonla:大陆站+国际站亚太-拉美北 bandwidth.aptowla:大陆站+国际站亚太-拉美西 bandwidth.cmtoaf:国际站中国大陆-南非 bandwidth.cmtoap:国际站中国大陆-亚太 bandwidth.cmtocm:国际站中国大陆-中国大陆 bandwidth.cmtoela:大陆站+国际站中国大陆-拉美东 bandwidth.cmtonla:大陆站+国际站中国大陆-拉美北 bandwidth.cmtowla:大陆站+国际站中国大陆-拉美西 bandwidth.elatoela:大陆站+国际站拉美东-拉美东 bandwidth.elatonla:大陆站+国际站拉美东-拉美北 bandwidth.wlatoela:大陆站+国际站拉美西-拉美东 bandwidth.wlatonla:大陆站+国际站拉美西-拉美北 bandwidth.wlatowla:大陆站+国际站拉美西-拉美西 最小长度:0 最大长度:32 billing_mode String 带宽包实例在大陆站或国际站的计费方式。 1:大陆站包周期 2:国际站包周期 3:大陆站按需计费 4:国际站按需计费 5:大陆站按95方式计费 6:国际站按95方式计费 charge_mode String 带宽包实例的计费方式。 bandwidth是按带宽计费。 最小长度:0 最大长度:64 bandwidth Integer 带宽包实例中的带宽值。 最小值:2 最大值:999999 resource_id String 带宽包实例绑定的资源ID。 最小长度:0 最大长度:36 resource_type String 带宽包实例绑定的资源类型。 cloud_connection: 云连接实例。 最小长度:0 最大长度:32 local_area_id String 本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:32 remote_area_id String 远端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:32 project_id String 项目ID。 最小长度:0 最大长度:36 interflow_mode String 互通类型: Area: 大区互通 Region: 城域互通 最小长度:0 最大长度:32 tags Array of Tag objects 标签列表。 表7 Tag 参数 参数类型 描述 key String 键 最小长度:1 最大长度:128 value String 值 最小长度:0 最大长度:255
  • 响应示例 状态码: 201 解除带宽包实例与云连接实例的绑定成功。 { "request_id" : "a47962646cdb043eaee9d87a588c0265", "bandwidth_package" : { "bandwidth" : 10, "status" : "ACTIVE", "id" : "XXX", "name" : "test_bwp_name", "description" : "", "domain_id" : "XXX", "created_at" : "2022-12-06T01:37:15Z", "updated_at" : "2022-12-08T11:34:55Z", "project_id" : "XXX", "resource_type" : "", "resource_id" : "", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "admin_state_up" : true, "charge_mode" : "bandwidth", "billing_mode" : "3", "spec_code" : "bandwidth.cmtocm", "order_id" : "", "product_id" : "", "enterprise_project_id" : "0", "interflow_mode" : "Area" }}
  • 请求示例 解除带宽包实例与云连接实例的绑定 POST https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages/{id}/disassociate{ "bandwidth_package" : { "resource_id" : "XXX", "resource_type" : "cloud_connection" }}
  • URI GET /v3/{domain_id}/ccaas/cloud-connection-routes 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 String 根据云连接路由ID过滤云连接路由条目列表。 最小长度:0 最大长度:36 cloud_connection_id 否 Array 根据云连接实例ID过滤云连接路由条目列表。 instance_id 否 Array 根据网络实例ID过滤云连接路由条目列表。 region_id 否 String 根据Region ID过滤云连接路由条目列表。 最小长度:0 最大长度:36
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 cloud_connection_routes Array of CloudConnectionRoute objects 云连接路由实例列表。 page_info PageInfo object 分页查询页的信息。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 CloudConnectionRoute 参数 参数类型 描述 id String 云连接实例路由的ID。 最小长度:0 最大长度:36 cloud_connection_id String 云连接实例的ID。 最小长度:0 最大长度:36 domain_id String 帐号ID。 最小长度:10 最大长度:32 project_id String 网络实例的项目ID。 最小长度:0 最大长度:36 instance_id String 路由条目下一跳指向的网络实例的ID。 最小长度:0 最大长度:36 type String 路由条目下一跳指向的网络实例的类型。 VPC:虚拟私有云。 VGW:虚拟网关。 最小长度:2 最大长度:3 region_id String Region的ID。 最小长度:0 最大长度:36 destination String 目的地址。 最小长度:0 最大长度:36 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页。 最小长度:0 最大长度:36 previous_marker String 上一页的marker,值为资源的uuid,为空时表示第一页。 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量。 最小值:0 最大值:2000
  • 响应示例 状态码: 200 查询云连接路由条目列表成功。 { "request_id" : "844d75196c487081d2a32187ea9d3757", "cloud_connection_routes" : [ { "id" : "XXX", "cloud_connection_id" : "XXX", "domain_id" : "XXX", "project_id" : "XXX", "instance_id" : "XXX", "type" : "vpc", "region_id" : "br-iaas-odin1", "destination" : "192.168.1.0/24" } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 1 }}
  • 响应示例 状态码: 200 查询授权列表成功。 { "request_id" : "bce57c774ed47dd828963e5ec3a0b06d", "authorisations" : [ { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2022-12-03T08:03:51Z", "updated_at" : "2022-12-03T08:03:51Z", "project_id" : "XXX", "region_id" : "region_id", "instance_type" : "vpc", "instance_id" : "XXX", "cloud_connection_domain_id" : "XXX", "cloud_connection_id" : "XXX", "status" : "authorized" } ], "page_info" : { "previous_marker" : "XXX", "current_count" : 1 }}
  • URI GET /v3/{domain_id}/ccaas/authorisations 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时,每页返回的个数。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 分页查询时,上一页最后一条记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 id 否 Array 根据ID过滤授权列表。 name 否 Array 根据名称过滤授权列表。 description 否 Array 根据描述过滤授权列表。 cloud_connection_id 否 Array 根据云连接实例ID过滤授权列表。 instance_id 否 Array 根据实例ID过滤授权列表。 缺省值:ACTIVE
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 authorisations Array of Authorisation objects 授权的详细信息。 page_info PageInfo object 分页查询页的信息。 request_id String 请求ID。 最小长度:0 最大长度:36 表5 Authorisation 参数 参数类型 描述 id String 授权的ID。 最小长度:0 最大长度:36 name String 授权的名称。 最小长度:0 最大长度:64 description String 授权的描述信息。 最小长度:0 最大长度:255 status String 授权的状态。 最小长度:0 最大长度:255 created_at String 创建授权的时间。 updated_at String 更新授权的时间。 domain_id String 授权者的账户ID。 最小长度:0 最大长度:36 instance_id String 授权实例的ID。 最小长度:0 最大长度:36 instance_type String 授权实例的类型。 最小长度:0 最大长度:255 region_id String 授权实例所属Region。 最小长度:0 最大长度:255 project_id String 授权实例所属项目ID。 最小长度:0 最大长度:36 cloud_connection_domain_id String 被授权云连接实例所属的账户ID。 最小长度:0 最大长度:36 cloud_connection_id String 被授权云连接实例ID。 最小长度:0 最大长度:36 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页。 最小长度:0 最大长度:36 previous_marker String 上一页的marker,值为资源的uuid,为空时表示第一页。 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量。 最小值:0 最大值:2000
  • URI DELETE /v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/{tag_key} 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID 最小长度:10 最大长度:32 resource_id 是 String 资源ID 最小长度:0 最大长度:36 tag_key 是 String 待删除资源标签的key 最小长度:1 最大长度:128 resource_type 是 String 资源类型: cloud-connection: 云连接 bandwidth-package: 带宽包
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 network_instance NetworkInstance object 网络实例。 request_id String 请求ID。 最小长度:0 最大长度:36 表6 NetworkInstance 参数 参数类型 描述 id String 网络实例的ID。 最小长度:0 最大长度:36 name String 网络实例的名字。 最小长度:0 最大长度:64 description String 网络实例的描述。 最小长度:0 最大长度:85 domain_id String 帐号ID。 最小长度:10 最大长度:32 status String 网络实例的状态。 ACTIVE:处理成功。 PENDING:处理中。 ERROR:处理失败。 最小长度:0 最大长度:36 created_at String 网络实例的创建时间。 UTC时间格式,yyyy-MM-ddTHH:mm:ss updated_at String 网络实例的更新时间。 UTC时间格式,yyyy-MM-ddTHH:mm:ss type String 网络实例的类型。 vpc:虚拟私有云。 vgw:虚拟网关。 最小长度:0 最大长度:36 cloud_connection_id String 云连接实例ID。 最小长度:0 最大长度:36 instance_id String 网络实例的ID。 最小长度:0 最大长度:36 instance_domain_id String 网络实例所属账户ID。 最小长度:0 最大长度:36 region_id String 网络实例所在Region的ID。 最小长度:0 最大长度:36 project_id String 网络实例所在租户的项目ID。 最小长度:0 最大长度:36 cidrs Array of strings 网络实例发布的网段路由列表。 最小长度:0 最大长度:64
  • 响应示例 状态码: 201 创建网络实例成功。 { "request_id" : "c8fe3d71352e273915bfbd74ce58368a", "network_instance" : { "id" : "XXX", "name" : "", "description" : "", "domain_id" : "XXX", "created_at" : "2022-06-24T09:33:15Z", "updated_at" : "2022-06-24T09:33:16Z", "project_id" : "XXX", "instance_domain_id" : "", "cloud_connection_id" : "XXX", "region_id" : "br-iaas-odin1", "type" : "vpc", "instance_id" : "XXX", "cidrs" : [ "192.168.1.0/24" ], "status" : "ACTIVE" }}
  • 请求示例 创建一个虚拟私有云实例,并指定该实例发布的网段路由列表 POST https://{cc_endpoint}/v3/{domain_id}/ccaas/network-instances{ "network_instance" : { "type" : "vpc", "region_id" : "br-iaas-odin1", "project_id" : "XXX", "cloud_connection_id" : "XXX", "instance_id" : "XXX", "cidrs" : [ "192.168.1.0/24" ] }}
  • 请求示例 创建一个带宽包实例,带宽值为5M,并指定带宽包的本端大区和远端大区 POST https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages{ "bandwidth_package" : { "project_id" : "XXX", "name" : "test_bwp_name", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "bandwidth" : 5, "charge_mode" : "bandwidth", "billing_mode" : 3, "interflow_mode" : "Area", "enterprise_project_id" : "0" }}
共100000条