华为云用户手册

  • 分钟 CDM 支持配置每几分钟执行一次作业,定时任务周期不建议小于5分钟。 开始时间:表示定时配置生效的时间,也是第一次自动执行作业的时间。 重复周期(分):从开始时间起,每多少分钟执行一次作业。 结束时间:该参数为可选参数,如果不配置则表示一直自动执行。如果配置了结束时间,则会在该时间停止自动执行作业。 图1 重复周期为分钟 例如图1表示:从2023年1月1日0时0分开始第一次自动执行作业,每30分钟自动执行一次,2023年12月31日23时59分之后不再自动执行。
  • 小时 CDM支持配置每几小时执行一次作业。 重复周期(时):表示每多少个小时自动执行一次定时任务。 触发时间(分):表示每小时的第几分钟触发定时任务。该参数值取值范围是“0~59”,可配置多个值但不可重复,最多60个,中间使用“,”分隔。 如果触发时间不在有效期内,则第一次自动执行的时间取有效期内最近的触发时间,例如: 有效期的“开始时间”为“1:20”。 “重复周期(时)”为“3”。 “触发时间(分)”为“10”。 有效期:分为开始时间和结束时间。 开始时间:表示定时配置生效的时间。 结束时间:该参数是可选参数,表示停止自动执行的时间。如果不配置,则表示一直自动执行。 图2 重复周期为小时 例如图2表示:定时配置从2023年1月1日0时0分生效,0:10时开始第一次自动执行作业,0:30第二次,0:50第三次,以后每2小时重复三次,2023年12月31日23时59分之后不再自动执行。
  • 月 CDM支持配置每几月执行一次作业。 重复周期(月):从开始时间起,每多少个月自动执行定时任务。 触发时间(天):选择每月的几号执行作业,该参数值取值范围是“1~31”,可配置多个值但不可重复,中间使用“,”分隔。 有效期:分为开始时间和结束时间。 开始时间:表示定时配置生效的时间。其中的时、分、秒也是每次自动执行的时间。 结束时间:该参数为可选参数,表示停止自动执行定时任务的时间。如果没有配置,则表示一直自动执行。 图5 重复周期为月 例如图5表示:从2023年1月1日0点开始,每月5日、25日的0点自动执行作业,直到2023年12月31日23时59分不再自动执行。
  • 响应示例 状态码: 200 请求成功。 { "api_version": "v1", "kind": "TimerRule", "spec": { "last_execution_time": "string", "items": [ { "component_name": "string", "component_id": "string", "status": "normal", "error_message": "", }, { "component_name": "string", "component_id": "string", "status": "abnormal", "error_message": "string", } ] } }
  • 响应示例 状态码: 200 请求成功。 { "api_version" : "v1", "kind" : "Volume", "items" : [ { "id" : "a061934d-52e3-4b36-aea7-6c51879f84c9", "resource_name" : "test", "resource_sub_type" : "parallel_file_system", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "time" : "2023-02-08T09:31:39.858115Z" }, { "id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59", "resource_name" : "test-nacos", "resource_sub_type" : "object_bucket", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "time" : "2023-02-08T09:31:49.232412Z" }, { "id" : "ece8ebcd-3f1e-4175-98ea-369036acbfce", "resource_name" : "test-nginx", "resource_sub_type" : "parallel_file_system", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "time" : "2023-02-15T03:24:08.146911Z" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本,固定值“v1”,该值不可修改。 枚举值: v1 kind String API类型,固定值“Agency”,该值不可修改。 枚举值: Agency agencies Array of AgencyItem objects 委托列表。 表4 AgencyItem 参数 参数类型 描述 name String 委托名称,固定值“cae_trust”,该值不可修改。
  • 2023年7月 序号 功能名称 功能描述 阶段 相关文档 1 云原生全力防高级版开通效率优化 DDoS原生高级防护-全力防高级版专属EIP自动化开通购买权限,无需等待人工开通。 商用 购买实例 2 DDoS高防新增规则导出功能 DDoS高防支持规则一键导出 商用 转发规则管理 3 DDoS高防新增证书管理功能 DDoS高防新增证书删除和批量删除功能。 商用 更新证书 4 DDoS高防支持日志服务 DDoS高防支持将安全事件攻击日志推送给LTS,您可在LTS分析攻击日志。 商用 防护日志管理
  • 能力实现流程 Jack在某快递官方网站浏览快递信息,有疑问需要电话咨询客服人员,Jack在网站输入自己的电话号码使用语音回呼业务联系客服人员,整个业务流程如图2所示。 图2 语音回呼能力实现流程 前提条件 快递网站服务器与语音通话平台对接正常,并根据实际情况开启录音功能。 该录音功能涉及个人用户通信内容。建议您只有在所适用法律法规允许的目的和范围内方可启用相应的功能。在使用、存储用户通信内容的过程中,您应采取足够的措施以确保用户的通信内容受到严格保护。 录音功能会涉及用户的通信内容,请确保更换的录音提示音满足当地法律法规的要求。
  • 通信云服务权限 默认情况下,管理员创建的 IAM 用户没有任何权限,需要将其加入用户组,并给用户组授予策略或角色,才能使得用户组中的用户获得对应的权限,这一过程称为授权。授权后,用户就可以基于被授予的权限对云服务进行操作。 通信云服务部署时通过物理区域划分,为项目级服务。授权时,“作用范围”需要选择“区域级项目”,然后在指定区域(如华北-北京一)对应的项目(cn-north-1)中设置相关权限,并且该权限仅对此项目生效;如果在“所有项目”中设置权限,则该权限在所有区域项目中都生效。访问通信云服务时,需要先切换至授权区域。 如表 通信云服务系统角色所示,包括了通信云服务的所有系统角色。由于华为云各服务之间存在业务交互关系,当通信云服务的角色依赖其他服务的角色实现功能时,给用户授予通信云服务的角色时,需要同时授予依赖的角色,通信云服务的权限才能生效。 表1 通信云服务系统角色 策略名称 描述 依赖关系 RTC Administrator 对消息&短信、 隐私保护通话 、语音通话的所有执行权限。 - 表2列出了语音通话平台常用操作与系统权限的授权关系,您可以参照该表选择合适的系统权限。 表2 常用操作与系统权限的关系 操作 RTC Administrator 添加/修改/删除企业 √ 添加/修改应用 √ 添加/修改号码订购 √ 添加/修改/删除放音文件 √ 添加/修改/删除语音模板 √
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • 请求示例 action为filter时,根据标签查询资源。 https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action { "offset" : "10", "limit" : "10", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] } action为count时,查询资源总数。 https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource_instances/action { "action" : "count", "not_tags" : [ { "key" : "key1", "values" : [ "value1", "*value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 resources Array of Resource objects 资源列表 total_count Integer 总记录数 request_id String 请求ID 表6 Resource 参数 参数类型 描述 resource_detail Object 资源详情。 资源对象,用于扩展。默认为空。 resource_id String 资源的ID resource_name String 资源名称,资源没有名称时默认为空字符串。 tags Array of Tag objects 标签列表,没有标签默认为空数组。 sys_tags Array of Tag objects 标签列表,没有标签默认为空数组。 表7 Tag 参数 参数类型 描述 key String 标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 最小长度:0 最大长度:36 value String 标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 最小长度:0 最大长度:43
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置, 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数 limit 否 String 查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1 action 是 String 操作标识(仅限于filter,count):filter(过滤),count(查询总条数) 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。禁止返回其他字段。 枚举值: filter count matches 否 Array of Match objects 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。此字段为固定字典值。根据不同的字段确认是否需要模糊匹配,如resource_name默认为模糊搜索(不区分大小写),如果value为空字符串精确匹配。resource_id为精确匹配。第一期只做resource_name,后续在扩展。 not_tags 否 Array of Tags objects 不包含标签,最多包含10个key,每个key下面的value最多10个, 结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 tags 否 Array of Tags objects 包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 tags_any 否 Array of Tags objects 包含任意标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 not_tags_any 否 Array of Tags objects 不包含任意标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回不包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 sys_tags 否 Array of Tags objects 仅op_service权限可以使用此字段做资源实例过滤条件。目前TMS调用时只包含一个tag结构体。key:_sys_enterprise_project_id,value:企业项目id列表。目前TMS调用时,key下面只包含一个value。0表示默认企业项目。sys_tags和租户标签过滤条件(without_any_tag 、tags、tags_any、not_tags、not_tags_any)不能同时使用。 表3 Match 参数 是否必选 参数类型 描述 key 是 String 键。取值范围为包括dc-directconnect/dc-vgw/dc-vif value 是 String 值。每个值最大长度255个unicode字符。 表4 Tags 参数 是否必选 参数类型 描述 key 是 String 键。最大长度127个unicode字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个unicode字符。
  • URI POST /v3/{project_id}/{resource_type}/resource-instances/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID resource_type 是 String 专线服务资源类型,包括dc-directconnect/dc-vgw/dc-vif dc-directconnect:专线物理连接 dc-vgw:虚拟网关 dc-vif:虚拟接口 枚举值: dc-directconnect dc-vgw dc-vif
  • 响应示例 状态码: 201 CREATED 成功创建接入虚拟私有云的虚拟网关。 { "virtual_gateway" : { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ], "enterprise_project_id" : "0" } }
  • 请求示例 创建一个接入虚拟私有云的虚拟网关,设置本地BGP ASN为64512,虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。 POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways { "virtual_gateway" : { "name" : "vgw-c7b22", "description" : "", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ] } }
  • 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 virtual_gateway VirtualGateway object 虚拟网关对象 request_id String 操作请求ID 表7 VirtualGateway 参数 参数类型 描述 id String 虚拟网关的ID vpc_id String 虚拟网关接入的VPC的ID tenant_id String 实例所属项目ID 最小长度:32 最大长度:32 name String 虚拟网关的名称 最小长度:0 最大长度:64 description String 虚拟网关的描述 最小长度:0 最大长度:128 type String 虚拟网关类型:default 缺省值:default local_ep_group Array of strings 虚拟网关到访问云上服务IPv4子网列表,通常是vpc的cidrs local_ep_group_ipv6 Array of strings 预留字段 虚拟网关到访问云上服务IPv6子网列表,通常是vpc的cidrs admin_state_up Boolean 管理状态:true或false 缺省值:true status String 操作状态,合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE bgp_asn Integer 虚拟网关本地的BGP自冶域号(asn) 最小值:1 最大值:4294967295 enterprise_project_id String 实例所属企业项目ID 最小长度:36 最大长度:36 tags Array of Tag objects 标签信息 数组长度:0 - 10 表8 Tag 参数 参数类型 描述 key String 标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 最小长度:0 最大长度:36 value String 标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 最小长度:0 最大长度:43
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token,请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 表3 请求Body参数 参数 是否必选 参数类型 描述 virtual_gateway 否 CreateVirtualGateway object 创建虚拟网关对象参数 表4 CreateVirtualGateway 参数 是否必选 参数类型 描述 vpc_id 是 String 虚拟网关接入的VPC的ID name 否 String 虚拟网关名称 最小长度:0 最大长度:64 description 否 String 虚拟网关的描述信息 最小长度:0 最大长度:128 local_ep_group 是 Array of strings 虚拟网关到访问云上服务IPv4子网列表,通常是vpc的cidrs local_ep_group_ipv6 否 Array of strings 预留字段 虚拟网关到访问云上服务IPv6子网列表,通常是vpc的cidrs bgp_asn 否 Integer 虚拟网关本地的BGP自冶域号(asn) 最小值:1 最大值:4294967295 enterprise_project_id 否 String 实例所属企业项目ID 最小长度:36 最大长度:36 tags 否 Array of Tag objects 标签信息 数组长度:0 - 10 表5 Tag 参数 是否必选 参数类型 描述 key 是 String 标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 最小长度:0 最大长度:36 value 否 String 标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 最小长度:0 最大长度:43
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 标签列表。 request_id String 请求ID 表3 Tag 参数 参数类型 描述 key String 标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 最小长度:0 最大长度:36 value String 标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 最小长度:0 最大长度:43
  • URI GET /v3/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID resource_type 是 String 专线服务资源类型,包括dc-directconnect/dc-vgw/dc-vif dc-directconnect:专线物理连接 dc-vgw:虚拟网关 dc-vif:虚拟接口 枚举值: dc-directconnect dc-vgw dc-vif
  • 请求示例 对虚拟接口下发shutdown命令,关闭接口。 POST https://{dc_endpoint}/v3/de58f033eb664102ba85e4a5db473ca5/dcaas/switchover-test { "switchover_test_record" : { "resource_type" : "virtual_interface", "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540", "operation" : "shutdown" } }
  • 响应示例 状态码: 201 CREATED { "switchover_test_record" : { "id" : "862d61f1-d9ea-4093-ba0e-2b8d415e3ab3", "tenant_id" : "de58f033eb664102ba85e4a5db473ca5", "resource_type" : "virtual_interface", "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540", "operation" : "shutdown", "start_time" : "2023-10-09T18:41:23.000Z", "end_time" : "2023-10-09T18:41:23.000Z", "operate_status" : "STARTING" }, "request_id" : "f91634a12b116b6f946d7871f5b4de18" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 表3 请求Body参数 参数 是否必选 参数类型 描述 switchover_test_record 否 CreateSwitchoverTest object 创建倒换测试记录对象参数 表4 CreateSwitchoverTest 参数 是否必选 参数类型 描述 resource_id 是 String 倒换测试的资源对象ID resource_type 否 String 倒换测试的资源对象类型 缺省值:virtual_interface 最小长度:0 最大长度:128 枚举值: virtual_interface operation 是 String shutdown、undo_shutdown表示倒换测试操作类型 最小长度:0 最大长度:128 枚举值: shutdown undo_shutdown
  • 功能介绍 客户双专线接入,需要支持双线自动倒换,方便进行功能测试。虚拟接口进行倒换测试会导致接口关闭,业务流量中断。 对于虚拟接口,支持“关闭接口”和“开放接口”两种操作。 关闭接口:下发shutdown命令,关闭接口。 开放接口:下发undo_shutdown命令,使能接口。 倒换测试选择shutdown时,虚拟接口的状态为ADMIN_SHUTDOWN,此状态不允许虚拟接口的其他操作。 倒换测试选择undo_shutdown时,虚拟接口的状态为ACTIVE。
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 request_id String 操作请求ID switchover_test_record SwitchoverTestRecord object 倒换测试记录信息 表6 SwitchoverTestRecord 参数 参数类型 描述 id String 倒换测试记录的唯一标识 tenant_id String 租户ID 最小长度:32 最大长度:32 resource_id String 倒换测试的资源对象ID resource_type String 倒换测试的资源对象类型 缺省值:virtual_interface 最小长度:0 最大长度:128 枚举值: virtual_interface operation String shutdown、undo_shutdown表示倒换测试操作类型 最小长度:0 最大长度:128 枚举值: shutdown undo_shutdown start_time String 倒换测试操作的开始时间 end_time String 倒换测试操作的结束时间 operate_status String 倒换测试状态记录 STARTING:初始状态 INPROGRESS:配置下发中 COMPLETE:配置下发完成 ERROR:配置下发失败 枚举值: STARTING INPROGRESS COMPLETE ERROR
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 操作请求ID virtual_gateways Array of VirtualGateway objects 虚拟网关对象列表 page_info PageInfo object 分页查询页的信息 表5 VirtualGateway 参数 参数类型 描述 id String 虚拟网关的ID vpc_id String 虚拟网关接入的VPC的ID tenant_id String 实例所属项目ID 最小长度:32 最大长度:32 name String 虚拟网关的名称 最小长度:0 最大长度:64 description String 虚拟网关的描述 最小长度:0 最大长度:128 type String 虚拟网关类型:default 缺省值:default local_ep_group Array of strings 虚拟网关到访问云上服务IPv4子网列表,通常是vpc的cidrs local_ep_group_ipv6 Array of strings 预留字段 虚拟网关到访问云上服务IPv6子网列表,通常是vpc的cidrs admin_state_up Boolean 管理状态:true或false 缺省值:true status String 操作状态,合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE bgp_asn Integer 虚拟网关本地的BGP自冶域号(asn) 最小值:1 最大值:4294967295 enterprise_project_id String 实例所属企业项目ID 最小长度:36 最大长度:36 tags Array of Tag objects 标签信息 数组长度:0 - 10 表6 Tag 参数 参数类型 描述 key String 标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 最小长度:0 最大长度:36 value String 标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 最小长度:0 最大长度:43 表7 PageInfo 参数 参数类型 描述 previous_marker String 上一页的marker,值为资源的uuid 最小长度:0 最大长度:36 current_count Integer 当前列表中资源数量 最小值:0 最大值:2000 next_marker String 下一页的marker,值为资源的uuid,为空时表示最后一页 最小长度:0 最大长度:36
  • 响应示例 状态码: 200 OK { "virtual_gateways" : [ { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ], "enterprise_project_id" : "0" } ], "request_id" : "765f7aaf8f2edd0e719de564ef72e2de" }
  • URI GET /v3/{project_id}/dcaas/virtual-gateways 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页返回的个数。 取值范围:1~2000。 最小值:1 最大值:2000 缺省值:2000 marker 否 String 上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 fields 否 Array 显示字段列表 数组长度:1 - 5 sort_dir 否 Array 返回结果按照升序(asc)或降序(desc)排列,默认为asc sort_key 否 String 排序字段 缺省值:id 最小长度:0 最大长度:36 id 否 Array 根据资源ID过滤实例 数组长度:1 - 5 enterprise_project_id 否 Array 根据企业项目ID过滤资源实例 数组长度:1 - 10 vpc_id 否 Array 通过VPC-ID过虑虚拟网关实例
  • 请求示例 更新虚拟网关名称和描述,将虚拟网关访问云上服务IPv4子网列表修改为192.168.3.0/24。 PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0 { "virtual_gateway" : { "name" : "update-vgw-c7b22", "description" : "", "local_ep_group" : [ "192.168.3.0/24" ] } }
共100000条