华为云用户手册

  • 响应参数 状态码: 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" }}
  • 响应示例 状态码: 201 创建带宽包实例成功。 { "request_id" : "61126320a1802d5c6444f9d2d76526c2", "bandwidth_package" : { "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" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_package 是 CreateBandwidthPackage object 创建带宽包请求体。 表4 CreateBandwidthPackage 参数 是否必选 参数类型 描述 name 是 String 带宽包实例的名字。 最小长度:1 最大长度:64 description 否 String 带宽包实例的描述。 最小长度:0 最大长度:85 enterprise_project_id 否 String 带宽包实例所属的企业项目ID。 缺省值:0 最小长度:0 最大长度:36 local_area_id 是 String 本端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:36 remote_area_id 是 String 远端大区。 云连接支持的大区有: | Chinese-Mainland | 中国大陆 | | Asia-Pacific | 亚太 | | Africa | 非洲 | | Western-Latin-America | 拉美西 | | Eastern-Latin-America | 拉美东 | | Northern-Latin-America | 拉美北 | 最小长度:0 最大长度:36 charge_mode 是 String 带宽包实例的计费方式。 bandwidth是按带宽计费。 最小长度:0 最大长度:64 billing_mode 是 Integer 带宽包实例在大陆站或国际站的计费方式: 3:大陆站按需计费 4:国际站按需计费 5:大陆站按95方式计费 6:国际站按95方式计费 bandwidth 是 Integer 带宽包实例中的带宽值。 最小值:2 最大值:999999 project_id 是 String 项目ID。 最小长度:0 最大长度:36 resource_id 否 String 带宽包实例绑定的资源ID。 最小长度:0 最大长度:36 resource_type 否 String 带宽包实例绑定的资源类型。 cloud_connection: 云连接实例。 最小长度:0 最大长度:36 interflow_mode 否 String 互通类型: Area: 大区互通 Region: 城域互通 最小长度:0 最大长度:36 spec_code 否 String 产品编码。 最小长度: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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 tag 否 Tag object 资源标签 表4 Tag 参数 是否必选 参数类型 描述 key 否 String 键 最小长度:1 最大长度:128 value 否 String 值 最小长度:0 最大长度:255
  • URI POST /v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最小长度:10 最大长度:32 resource_id 是 String 资源ID。 最小长度:0 最大长度:36 resource_type 是 String 资源类型: cloud-connection: 云连接 bandwidth-package: 带宽包
  • 响应示例 状态码: 201 创建云连接实例成功。 { "cloud_connection" : { "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 }, "request_id" : "d793a71f70e9370278b046ae39338393"}
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 cloud_connection CloudConnection object 云连接实例。 request_id String 请求ID。 最小长度:0 最大长度:36 表6 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 表7 Tag 参数 参数类型 描述 key String 键 最小长度:1 最大长度:128 value String 值 最小长度:0 最大长度:255
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 authorisation Authorisation object 授权 request_id String 请求ID。 最小长度:0 最大长度:36 表6 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
  • 请求示例 创建云连接实例所属租户加载网络实例的授权 POST https://{cc_endpoint}/v3/{domain_id}/ccaas/authorisations{ "authorisation" : { "region_id" : "region_id", "instance_id" : "XXX", "instance_type" : "vpc", "cloud_connection_domain_id" : "XXX", "cloud_connection_id" : "XXX", "project_id" : "XXX" }}
  • 响应示例 状态码: 201 创建授权成功。 { "request_id" : "6a1865ef10104295db6e3b641284b3ed", "authorisation" : { "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" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 authorisation 是 CreateAuthorisation object 创建授权的详细信息。 表4 CreateAuthorisation 参数 是否必选 参数类型 描述 name 否 String 授权的名称。 最小长度:0 最大长度:64 description 否 String 授权的描述信息。 最小长度:0 最大长度:85 instance_id 是 String 授权网络实例的ID。 最小长度:0 最大长度:36 instance_type 是 String 授权网络实例的类型: vpc:虚拟私有云 最小长度:0 最大长度:255 project_id 是 String 授权网络实例所属项目。 最小长度:0 最大长度:36 region_id 是 String 授权实例所属Region。 最小长度:0 最大长度:255 cloud_connection_domain_id 是 String 被授权云连接实例所属的账户ID。 最小长度:0 最大长度:36 cloud_connection_id 是 String 被授权云连接实例ID。 最小长度:0 最大长度:36
  • 请求示例 创建一个域间带宽实例,并指定本端与对端RegionID POST https://{cc_endpoint}/v3/{domain_id}/ccaas/inter-region-bandwidths{ "inter_region_bandwidth" : { "bandwidth" : "5", "cloud_connection_id" : "XXX", "inter_region_ids" : [ "region_a", "region_b" ], "bandwidth_package_id" : "XXX" }}
  • 响应示例 状态码: 201 创建域间带宽实例成功。 { "inter_region_bandwidth" : { "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" } ] }, "request_id" : "fd403735e22a5213845afbf69425a976"}
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 inter_region_bandwidth InterRegionBandwidth object 域间带宽实例。 request_id String 请求ID。 最小长度:0 最大长度:36 表6 InterRegionBandwidth 参数 参数类型 描述 id String 域间带宽实例的ID。 最小长度:0 最大长度:36 name String 域间带宽实例的名字。 最小长度:0 最大长度:64 description String 域间带宽实例的描述。 最小长度:0 最大长度:85 domain_id String 帐号ID。 最小长度:0 最大长度:36 bandwidth_package_id String 带宽包实例的ID。 最小长度:0 最大长度:36 created_at String 域间带宽实例的创建时间。 updated_at String 域间带宽实例的更新时间。 cloud_connection_id String 云连接实例的ID。 最小长度:0 最大长度:36 inter_regions Array of InterRegion objects 域间实例信息。 bandwidth Integer 域间带宽的值。 最小值:1 最大值:999999 表7 InterRegion 参数 参数类型 描述 id String 域间实例的ID。 最小长度:0 最大长度:36 project_id String 域间实例本段的项目ID。 最小长度:0 最大长度:36 local_region_id String 域间实例本段的RegionID。 最小长度:0 最大长度:36 remote_region_id String 域间实例对段的RegionID。 最小长度:0 最大长度:36
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 inter_region_bandwidth 是 CreateInterRegionBandwidth object 创建域间带宽的详情信息。 表4 CreateInterRegionBandwidth 参数 是否必选 参数类型 描述 cloud_connection_id 是 String 云连接实例ID。 最小长度:0 最大长度:36 bandwidth_package_id 是 String 带宽包实例ID。 最小长度:0 最大长度:36 bandwidth 是 Integer 域间带宽值。 最小值:1 最大值:999999 inter_region_ids 是 Array of strings 域间RegionID。 最小长度:2 最大长度:2
  • 响应示例 状态码: 201 将带宽包实例绑定到云连接实例成功。 { "request_id" : "7441ece2642bf528cc87ae1d737f4e3c", "bandwidth_package" : { "bandwidth" : 10, "status" : "ACTIVE", "id" : "XXX", "name" : "test_bwp_name", "description" : "", "domain_id" : "ae677c95cc43449fb4a60ea35a997c21", "created_at" : "2022-12-06T01:37:15Z", "updated_at" : "2022-12-08T11:34:55Z", "project_id" : "XXX", "resource_type" : "cloud_connection", "resource_id" : "XXX", "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" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 最小长度:0 最大长度:102400 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_package 是 AssociateBandwidthPackage object 将带宽包实例关联到资源的详细信息。 表4 AssociateBandwidthPackage 参数 是否必选 参数类型 描述 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
  • URI POST /v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID 最小长度:10 最大长度:32 resource_id 是 String 资源ID 最小长度:0 最大长度:36 resource_type 是 String 资源类型: cloud-connection: 云连接 bandwidth-package: 带宽包
  • 请求示例 批量创建资源标签,如果key相同则更新value,如果key不存在则添加value POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action{ "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value3" } ]} 批量删除资源标签,仅根据key进行删除,忽略value POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action{ "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value3" } ]}
共100000条