华为云用户手册

  • 响应参数 表2 响应参数 参数名称 类型 说明 routers Array of router objects router对象列表,参见表3。 routers_links Array of routers_link objects 分页信息,参见表6。 只有在使用limit过滤,并且资源个数超过limit或者资源个数超过2000时(limit默认值),该参数的rel和href取值才会显示为next和其对应的link。 表3 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-(中划线)、.(点)。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态,可以为ACTIVE, DOWN,ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性:外部网关信息,参见external_gateway_info对象 routes Array of route objects 扩展属性:路由信息列表,参见routes对象 project_id String 项目ID,请参见获取项目ID。 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表4 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表5 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址,nexthop仅支持是router所关联的子网范围内IP地址 表6 routers_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系
  • 响应示例 { "subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "port_id": "40e86635-b2a3-45de-a7c8-3cced5b7e755", "id": "5b8e885c-1347-4ac2-baf9-2249c8ed1270"}
  • 请求示例 路由器添加接口,路由器id为5b8e885c-1347-4ac2-baf9-2249c8ed1270,子网id为ab78be2d-782f-42a5-aa72-35879f6890ff。 PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface{"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"}
  • 响应示例 { "router": { "id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe", "name": "xiaoleizi-tag", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [ { "destination": "0.0.0.0/0", "nexthop": "172.16.0.124" } ], "created_at": "2018-03-23T09:26:08", "updated_at": "2018-08-24T08:49:53" }}
  • 响应参数 表1 响应参数 参数名称 类型 说明 router router object router对象,参见表2。 表2 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-(中划线)、.(点)。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态,可以为ACTIVE, DOWN,ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性:外部网关信息,参见external_gateway_info对象 routes Array of route objects 扩展属性:路由信息列表,参见表4 project_id String 项目ID,请参见获取项目ID。 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表3 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表4 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址,nexthop仅支持是router所关联的子网范围内IP地址
  • 响应示例 { "router": { "id": "f5dbdfe0-86f9-4b0a-9a32-6be143f0a076", "name": "router-test2", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [], "created_at": "2018-09-20T02:06:07", "updated_at": "2018-09-20T02:06:09" }}
  • 请求参数 表1 请求参数 参数名称 类型 是否必选 说明 router router object 是 router对象,参见表2。 表2 router对象 属性 是否必选 类型 说明 name 否 String 路由器的名称。 【使用说明】 仅支持数字、字母、_(下划线)、-(中划线)、.(点)。 admin_state_up 否 Boolean 管理状态。 【取值范围】 只支持true。 external_gateway_info 否 external_gateway_info object 扩展属性:外部网关信息,参见external_gateway_info对象 表3 external_gateway_info对象 属性 是否必选 类型 说明 network_id 否 String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。
  • 响应参数 表4 响应参数 参数名称 类型 说明 router router object router对象,参见表5 表5 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-(中划线)、.(点)。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态,可以为ACTIVE, DOWN,ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性:外部网关信息,参见external_gateway_info对象 routes Array of route objects 扩展属性:路由信息列表,参见routes对象 project_id String 项目ID,请参见获取项目ID。 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表6 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表7 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址,nexthop仅支持是router所关联的子网范围内IP地址
  • 响应示例 { "routes": [ { "type": "peering", "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", "destination": "192.168.200.0/24", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" } ] }
  • URI GET /v2.0/vpc/routes 样例: 样例:GET https://{Endpoint}/v2.0/vpc/routes?id={id}&vpc_id={vpc_id}&tenant_id={tenant_id}&destination={destination}&type={type}&limit={limit}&marker={marker} 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 id 否 String 按照routes_id过滤查询 tenant_id 否 String 按照tenant_id过滤查询 vpc_id 否 String 按照vpc_id过滤查询 destination 否 String 按照路由目的地址CIDR过滤查询 type 否 String 按照type进行过滤查询,目前只支持peering marker 否 String 分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用: 若不传入marker和limit参数,查询结果返回第一页全部资源记录。 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。 limit需要和marker配合使用,详细规则请见marker的参数说明。 默认值为2000。
  • 响应参数 表2 响应参数 参数名称 类型 说明 routes Array of route objects route对象列表,参见表3。 routes_links Array of routes_link objects routes_link对象列表,参见表4。 只有在使用limit过滤,并且资源个数超过limit或者资源个数超过2000时(limit默认值),该参数的rel和href取值才会显示为next和其对应的link。 表3 route对象 属性 类型 说明 id String 路由id destination String 路由目的地址CIDR,如192.168.200.0/24。 nexthop String 路由下一跳,如果路由是“peering”类型,填写vpc peering id。 type String 路由类型。目前只支持“peering”。 vpc_id String 路由的vpc,需要填写存在的vpc_id。 tenant_id String 项目ID 表4 routes_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系
  • URI GET /v1/{project_id}/subnets/{subnet_id}/privateips 样例: GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID,获取项目ID请参见获取项目ID。 subnet_id 是 String 私有IP所在子网的唯一标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 marker 否 String 分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用: 若不传入marker和limit参数,查询结果返回第一页全部资源记录。 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。 limit需要和marker配合使用,详细规则请见marker的参数说明。
  • 响应参数 表2 请求参数 名称 参数类型 说明 privateips Array of privateip objects 私有IP列表对象,请参见表3。 表3 privateip字段说明 名称 参数类型 说明 status String 功能说明:私有IP的状态 取值范围: ACTIVE:活动的 DOWN:不可用 id String 私有IP标识 subnet_id String 分配IP的子网标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 tenant_id String 项目ID device_owner String 功能说明:私有IP的使用者,空表示未使用 取值范围: network:dhcp DHCP服务IP地址 network:router_interface_distributed 网关IP地址 compute:xxx(xxx对应具体的可用区名称,例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用) 虚拟机网卡IP地址 neutron:VIP_PORT 虚拟IP地址 compute:subeni 辅助弹性网卡IP地址 neutron:LOADBALANCERV2 共享ELB使用的IP地址 neutron:LOADBALANCERV3 独享ELB使用的IP地址 network:endpoint_interface VPC终端节点使用的IP地址 约束:此处的取值范围只是本服务支持的类型,其他类型未做标注 ip_address String 申请到的私有IP
  • 响应示例 { "privateips": [ { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f78", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.11" }, { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f79", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.12" } ]}
  • 响应示例 { "route": { "type": "peering", "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", "destination": "192.168.200.0/24", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" }}
  • 响应参数 表2 响应参数 参数名称 类型 说明 route route object route对象,参见表3。 表3 route对象 属性 类型 说明 id String 路由id destination String 路由目的地址CIDR,如192.168.200.0/24。 nexthop String 路由下一跳,如果路由是“peering”类型,填写vpc peering id。 type String 路由类型。目前只支持“peering”。 vpc_id String 路由的vpc,需要填写存在的vpc_id。 tenant_id String 项目ID
  • 响应参数 表3 响应参数 参数名称 类型 说明 firewall_rule firewall_rule object firewall rule对象。请参见表4。 表4 Firewall Rule对象 属性 类型 说明 id String 网络ACL规则的uuid标识。 name String 网络ACL规则名称。 description String 网络ACL规则描述。 tenant_id String 项目ID public Boolean 是否支持跨租户共享。 protocol String IP协议。 source_port String 源端口号或者一段端口范围。 destination_port String 目的端口号或者一段端口范围。 ip_version Integer IP协议版本。 source_ip_address String 源地址或者CIDR。 destination_ip_address String 目的地址或者CIDR。 action String 对通过网络ACL的流量执行的操作。 enabled Boolean 是否使能网络ACL规则。 project_id String 项目ID,请参见获取项目ID。
  • 响应示例 { "firewall_rule": { "protocol": "tcp", "description": "", "source_ip_address": null, "destination_ip_address": null, "source_port": null, "destination_port": "80", "id": "b94acf06-efc2-485d-ba67-a61acf2a7e28", "name": "ALLOW_HTTP", "tenant_id": "23c8a121505047b6869edf39f3062712", "enabled": true, "action": "deny", "ip_version": 4, "public": false, "project_id": "23c8a121505047b6869edf39f3062712" }}
  • 请求参数 表1 请求参数 参数名称 类型 必选 说明 firewall_rule firewall_rule object 是 firewall rule对象。请参见表2。 表2 Firewall Rule对象 属性 是否必选 类型 说明 name 否 String 网络ACL规则名称。 使用说明:最长255个字符 description 否 String 网络ACL规则描述。 使用说明:最长255个字符 protocol 否 String IP协议。 取值范围:支持TCP,UDP,ICMP, ICMPV6, 或者0-255 source_port 否 String 源端口号或者一段端口范围。 取值范围:位于[1,65535]中一个整数或者一段端口范围a:b destination_port 否 String 目的端口号或者一段端口范围。 取值范围:位于[1,65535]中一个整数或者一段端口范围a:b ip_version 否 Integer IP协议版本。 取值范围:4、6,分别表示创建ipv4和ipv6。 source_ip_address 否 String 源地址或者CIDR。 destination_ip_address 否 String 目的地址或者CIDR。 action 否 String 对通过网络ACL的流量执行的操作。 取值范围:deny(拒绝)/allow(允许) enabled 否 Boolean 是否使能网络ACL规则。 取值范围:true/false
  • 请求示例 更新id为b94acf06-efc2-485d-ba67-a61acf2a7e28的ACL规则,action更新为deny。 PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28{ "firewall_rule": { "action": "deny" }}
  • 请求示例 更新id为2fb0e81f-9f63-44b2-9894-c13a3284594a的ACL策略,关联ACL规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a { "firewall_policy": { "firewall_rules": [ "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ] }}
  • 响应示例 { "firewall_policy": { "description": "", "firewall_rules": [ "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "2fb0e81f-9f63-44b2-9894-c13a3284594a", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712" }}
  • 响应参数 表3 响应参数 参数名称 类型 说明 firewall_policy firewall_policy object firewall policy对象。请参见表4。 表4 Firewall Policy对象 属性 类型 说明 id String 网络ACL策略uuid标识。 name String 网络ACL策略名称。 description String 网络ACL策略描述。 tenant_id String 项目ID firewall_rules Array of strings 策略引用的网络ACL规则链。 audited Boolean 审计标记。 public Boolean 是否支持跨租户共享。 project_id String 项目ID,请参见获取项目ID。
  • 响应示例 { "description": "", "firewall_rules": [ "b8243448-cb3c-496e-851c-dadade4c161b" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712"}
  • 响应参数 表2 响应参数 参数名称 类型 说明 description String 对policy的描述信息 audited Boolean 每次policy或者它相关的rule有变动,该参数将会被置为False firewall_rules Array of strings 与当前policy相关联的rule的ID列表 id String policy ID name String Policy名称 public Boolean 如果为True,该policy对于其他项目网络ACL策略可见, 默认不可见 tenant_id String 项目ID project_id String 项目ID
  • 请求参数 表1 请求参数 参数名称 类型 必选 说明 firewall_policy firewall_policy object 是 firewall policy对象。请参见表2。 表2 Firewall Policy对象 属性 是否必选 类型 说明 name 否 String 网络ACL策略名称。 使用说明:最长255个字符 description 否 String 网络ACL策略描述。 使用说明:最长255个字符 firewall_rules 否 Array of strings 策略引用的网络ACL规则链。 audited 否 Boolean 审计标记。 取值范围:true/false
  • 请求示例 在id为afc52ce9-5305-4ec9-9feb-44feb8330341的ACL策略中移除ACL规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule { "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1"}
  • 请求示例 在id为afc52ce9-5305-4ec9-9feb-44feb8330341的ACL策略中插入规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1,插入到规则b8243448-cb3c-496e-851c-dadade4c161b后面。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule { "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", "insert_before": ""}
  • 响应参数 表3 响应参数 参数名称 类型 说明 description String 对policy的描述信息 audited Boolean 每次policy或者它相关的rule有变动,该参数将会被置为False firewall_rules Array of strings 与当前policy相关联的rule的ID列表 id String policy ID name String Policy名称 public Boolean 如果为true,该policy对于其他项目网络ACL策略可见, 默认不可见 tenant_id String 项目ID project_id String 项目ID
  • 响应示例 { "description": "", "firewall_rules": [ "b8243448-cb3c-496e-851c-dadade4c161b", "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712"}
共100000条