华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询地址组成员返回数据 表5 data 参数 参数类型 描述 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 limit Integer 每页显示个数,范围为1-1024 total Integer 总数 set_id String 地址组id records Array of records objects 成员信息 表6 records 参数 参数类型 描述 item_id String 地址组成员id name String 地址组成员name description String 描述 address_type Integer 地址组类型,0 ipv4,1 ipv6 address String 地址组 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI GET /v1/{project_id}/address-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 set_id 是 String 地址组id key_word 否 String 关键字 limit 是 Integer 每页显示个数,范围为1-1024 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 address 否 String ip地址 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建 云防火墙 后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 query_address_set_type 否 Integer 查询地址组类型,0表示自定义地址组,1表示预定义地址组
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data IpsProtectModeObject object ips防护模式数据 表5 IpsProtectModeObject 参数 参数类型 描述 id String ips防护模式id mode Integer ips防护模式,0:观察模式,1:严格模式,2:中等模式,3:宽松模式 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429的ips防护模式。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
  • URI GET /v1/{project_id}/ips/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 响应示例 状态码: 200 OK { "data" : { "limit" : 10, "records" : [ { "action" : "deny", "app" : "PING", "dst_ip" : "100.85.216.211", "dst_port" : 59, "hit_time" : 1664164255000, "log_id" : "46032", "protocol" : "ICMP: ECHO_REQUEST", "rule_id" : "c755be1c-4b92-4ae7-a15e-c2d02b152538", "rule_name" : "eip_ipv4_w_n_default_deny", "src_ip" : "100.95.148.49", "src_port" : 24954, "src_province_id" : "source province id", "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", "dst_province_id" : "dst province id", "dst_province_name" : "dst province name", "dst_city_id" : "dst city id", "dst_city_name" : "dst city name" } ], "total" : 1 } } 状态码: 400 Bad Request { "error_code" : "CFW.00500002", "error_msg" : "时间间距错误" }
  • 请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318,开始时间为1664159069544,结束时间为1664162669544,初始位置为0的第一页的数据 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/access-control?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1664159069544&end_time=1664162669544&limit=10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询访问控制日志返回数据 表5 data 参数 参数类型 描述 total Integer 返回数量 limit Integer 每页显示个数,范围为1-1024 records Array of records objects 记录 表6 records 参数 参数类型 描述 action String 动作0:permit,1:deny rule_name String 规则名称 rule_id String 规则ID hit_time Long 命中时间,以毫秒为单位的时间戳,如1718936272648 src_region_id String 源区域id src_region_name String 源区域name dst_region_id String 目的区域id dst_region_name String 目的区域name log_id String 文档ID src_ip String 源IP src_port Integer 源端口 dst_ip String 目的IP dst_port Integer 目的端口 protocol String 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 app String 应用协议 dst_host String 目标主机 src_province_id String 源省份id src_province_name String 源省份名称 src_city_id String 源城市id src_city_name String 源城市名称 dst_province_id String 目的省份id dst_province_name String 目的省份名称 dst_city_id String 目的城市id dst_city_name String 目的城市名称 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI GET /v1/{project_id}/cfw/logs/access-control 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 rule_id 否 String 规则ID start_time 是 Long 开始时间,以毫秒为单位的时间戳,如1718936272648 end_time 是 Long 结束时间,以毫秒为单位的时间戳,如1718936272648 src_ip 否 String 源IP src_port 否 Integer 源端口 dst_ip 否 String 目的IP dst_port 否 Integer 目的端口 protocol 否 String 协议类型,包含TCP, UDP,ICMP,ICMPV6等。 app 否 String 应用协议 log_id 否 String 文档ID,第一页为空,其他页不为空,其他页可取上一次查询最后一条数据的log_id next_date 否 Integer 下个日期,当是第一页时为空,不是第一页时不为空,其他页可取上一次查询最后一条数据的start_time offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于0,首页时为空,非首页时不为空 limit 是 Integer 每页显示个数,范围为1-1024 log_type 否 String 日志类型包括:internet,vpc,nat 枚举值: internet nat vpc enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 dst_host 否 String 目标主机 rule_name 否 String 规则名称 action 否 String 动作包含permit,deny src_region_name 否 String 源region名称 dst_region_name 否 String 目的region名称 src_province_name 否 String 源省份名称 dst_province_name 否 String 目的省份名称 src_city_name 否 String 源城市名称 dst_city_name 否 String 目的城市名称
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data CreateEWFirewallResp object 创建东西向防火墙返回值 表6 CreateEWFirewallResp 参数 参数类型 描述 id String 东西向防护id er ER object ER信息 inspertion_vpc CreateEWFirewallInspectVpcResp object 引流vpc信息 表7 ER 参数 参数类型 描述 er_id String ER ID er_attach_id String ER连接ID 表8 CreateEWFirewallInspectVpcResp 参数 参数类型 描述 vpc_id String vpc id subnet_ids Array of strings 子网列表
  • 请求示例 项目09bb24e6f280d23d0f9fc0104b901480下防火墙55b26ab5-e4b0-40e8-941c-a1778fe2a500创建er模式防火墙inspection_cidr为10.1.0.0/24,er_id为e0b22a23-02cf-4092-ace9-34b39e10dc77。 https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?fw_instance_id=55b26ab5-e4b0-40e8-941c-a1778fe2a500&enterprise_project_id=default { "inspection_cidr" : "10.1.0.0/24", "mode" : "er", "er_id" : "e0b22a23-02cf-4092-ace9-34b39e10dc77" }
  • 响应示例 状态码: 200 创建东西向防火墙返回值 { "data" : { "id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651", "er" : { "er_id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", "er_attach_id" : "bd62ddd3-5e20-482b-aefa-9e2940e2b1a9" }, "inspertion_vpc" : { "vpc_id" : "00672633-0466-4c35-99ef-5e3f5c813a4b", "subnet_ids" : [ "294682a0-1e85-45f5-92c8-e52bee09c204", "a86277bb-35d5-4442-bc0b-2e9d4e6a9080", "95829240-14e0-47e6-b9e7-2ac228e7b00f" ] } } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 er_id 否 String 出方向关联ER实例id inspection_cidr 是 String inspection cidr mode 是 String 东西向防火墙模式,填写er
  • URI POST /v1/{project_id}/firewall/east-west 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data CaptureResultUrlVO object 抓包结果url 表5 CaptureResultUrlVO 参数 参数类型 描述 captcha String 下载链接提取码 expires Long 下载链接过期时间 file_list Array of CaptureFile objects 抓包文件列表 request_header HostHeaderInfo object 主机请求头 url String 下载链接 表6 CaptureFile 参数 参数类型 描述 file_name String 文件名称 url String 下载链接 file_path String 文件路径 表7 HostHeaderInfo 参数 参数类型 描述 Host String 主机
  • URI GET /v1/{project_id}/capture-task/capture-result 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 task_id 是 String 抓包任务id type 否 Integer 是否指定公网ip下载,0:无限制,1:指定公网ip下载 ip 否 Array 指定公网ip enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。
  • 请求示例 查询项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4下的抓包任务结果。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/capture-result?fw_instance_id=14f99b45-47df-4e40-aa5d-cf3700ce9c8b&enterprise_project_id=default&task_id=ea47d7f9-8b93-45de-978d-b4bf0613cfed&type=0
  • 请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4停止任务id为1dcddab3-7d79-4a56-9e67-4aa0962b98ad的抓包任务。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/stop?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default { "task_id" : "1dcddab3-7d79-4a56-9e67-4aa0962b98ad" }
  • URI POST /v1/{project_id}/capture-task/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。
  • 响应示例 状态码: 200 查询抓包任务返回值 { "data" : { "limit" : 50, "offset" : 0, "records" : [ { "capture_size" : "--", "created_date" : "2024/06/04 11:23:50", "dest_address" : "2.2.2.2", "dest_address_type" : 0, "dest_port" : "", "duration" : 3, "is_deleted" : 0, "max_packets" : 100000, "modified_date" : "2024/06/04 11:23:50", "name" : "zhuabaotest", "protocol" : -1, "remaining_days" : 7, "source_address" : "1.1.1.1", "source_address_type" : 0, "source_port" : "", "status" : 2, "task_id" : "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" } ], "total" : 1 } }
  • 请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4查询50条抓包任务。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default&limit=50&offset=0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of HttpQueryCaptureTaskResponseData objects 查询抓包任务返回值。 表5 HttpQueryCaptureTaskResponseData 参数 参数类型 描述 limit Integer 每页显示个数,范围为1-1024 object_id String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 project_id String 租户project_id total Long 抓包任务总数 records Array of CaptureTaskVO objects 抓包任务列表 表6 CaptureTaskVO 参数 参数类型 描述 capture_size String 抓包大小 created_date String 抓包创建时间 dest_address String 目的地址 dest_address_type Integer 目的地址类型0 ipv4,1 ipv6 dest_port String 目的端口 duration Integer 抓包时长 is_deleted Integer 是否被删除,0否 1是 max_packets Integer 最大抓包数 modified_date String 修改日期 name String 抓包任务名称 protocol Integer 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 remaining_days Integer 剩余保留天数 source_address String 源地址 source_address_type Integer 源地址类型0 ipv4,1 ipv6 source_port String 源端口 status Integer 抓包任务状态 task_id String 抓包任务id
  • URI GET /v1/{project_id}/capture-task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 limit 是 Integer 每页显示个数,范围为1-1024 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0
  • 请求示例 删除项目id为0b2179bbe180d3762fb0c01a2d5725c7,防火墙id为5e7eba7f-5de4-4ce9-8f60-11330dfc6565下的防火墙标签,标签key值为keytest,value为valuetest https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete { "tags" : [ { "key" : "keytest", "value" : "valuetest" } ] }
  • URI DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表 表4 ResourceTag 参数 是否必选 参数类型 描述 key 否 String 键 value 否 String 值 update_time 否 String 更新时间
  • 响应示例 状态码: 200 列举执行计划成功 { "execution_plans" : [ { "stack_name" : "my_hello_world_stack", "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7", "execution_plan_id" : "b3e7e15f-f96b-4190-94f4-bb8120f8c4dc", "execution_plan_name" : "my_third_execution_plan", "description" : "my third execution plan", "status" : "AVAILABLE", "create_time" : "2023-05-15T15:39:25Z" }, { "stack_name" : "my_hello_world_stack", "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7", "execution_plan_id" : "3ca87537-8d5c-4c9d-9292-d19068aaacbb", "execution_plan_name" : "my_second_execution_plan", "description" : "my second execution plan", "status" : "APPLIED", "create_time" : "2023-05-15T15:32:45Z" }, { "stack_name" : "my_hello_world_stack", "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7", "execution_plan_id" : "8c1fb31d-9eec-4ce3-a4e6-fd07059cec83", "execution_plan_name" : "my_first_execution_plan", "description" : "my first execution plan", "status" : "CREATION_FAILED", "status_message" : "Failed to init workflow due to bad template. Error: Invalid variable name A name must start with a letter or underscore and may contain only letters, digits, underscores, and dashes.", "create_time" : "2023-05-15T12:23:38Z" } ] }
  • 请求示例 列举用户指定资源栈下的所有的执行计划 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans 列举用户指定资源栈下的所有的执行计划,并提供资源栈id以校验是否与当前资源栈匹配 GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans?stack_id=f689e9fd-97e7-4185-bd8a-7d5f708d45d7
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 execution_plans Array of ExecutionPlan objects 执行计划列表。默认按照生成时间降序排序,最新生成的在最前 表5 ExecutionPlan 参数 参数类型 描述 stack_name String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 最小长度:1 最大长度:128 stack_id String 资源栈(stack)的唯一Id。 此Id由 资源编排 服务在生成资源栈的时候生成,为UUID。 由于资源栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的资源栈,删除,再重新创建一个同名资源栈。 对于团队并行开发,用户可能希望确保,当前我操作的资源栈就是我认为的那个,而不是其他队友删除后创建的同名资源栈。因此,使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致,则返回400 最小长度:36 最大长度:36 execution_plan_id String 执行计划(execution_plan)的唯一Id。 此Id由资源编排服务在生成执行计划的时候生成,为UUID。 由于执行计划名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的执行计划,删除,再重新创建一个同名执行计划。 对于团队并行开发,用户可能希望确保,当前我操作的执行计划就是我认为的那个,而不是其他队友删除后创建的同名执行计划。因此,使用ID就可以做到强匹配。 资源编排服务保证每次创建的执行计划所对应的ID都不相同,更新不会影响ID。如果给予的execution_plan_id和当前执行计划的ID不一致,则返回400 注意: 创建执行计划后,资源编排服务持久化请求并立即返回,客户端不等待请求最终处理完成,用户无法实时感知请求处理结果 资源编排服务最终会将异步部署请求排队,在服务端空闲的情况下逐个处理。用户最大等待时长为1小时 最小长度:36 最大长度:36 execution_plan_name String 执行计划的名称。此名字在domain_id+区域+project_id+stack_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 最小长度:1 最大长度:128 description String 执行计划的描述。可用于客户识别自己的执行计划。 最小长度:0 最大长度:1024 status String 执行计划的状态 * CREATION_IN_PROGRESS - 正在创建,请等待 * CREATION_FAILED - 创建失败,请从status_message获取错误信息汇总 * AVAILABLE - 创建完成,可以调用ApplyExecutionPlan API进行执行 * APPLY_IN_PROGRESS - 执行中,可通过GetStackMetadata查询资源栈状态,通过ListStackEvents获取执行过程中产生的资源栈事件 * APPLIED - 已执行 枚举值: CREATION_IN_PROGRESS CREATION_FAILED AVAILABLE APPLY_IN_PROGRESS APPLIED status_message String 当执行计划的状态为创建失败状态(即为 CREATION_FAILED 时),将会展示简要的错误信息总结以供debug create_time String 执行计划的生成时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z apply_time String 执行计划的执行时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表7 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表9 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表11 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表13 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码: 429 表14 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表15 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息 状态码: 500 表16 响应Body参数 参数 参数类型 描述 error_code String 响应码 最小长度:11 最大长度:11 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。 表17 Detail 参数 参数类型 描述 error_code String 响应码 error_msg String 响应消息
  • URI GET /v1/{project_id}/stacks/{stack_name}/execution-plans 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,可以从调用API处获取,也可以从控制台获取。 项目ID获取方式 最小长度:3 最大长度:64 stack_name 是 String 资源栈的名称。此名字在domain_id+区域+project_id下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。 最小长度:1 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 stack_id 否 String 资源栈(stack)的唯一Id。 此Id由资源编排服务在生成资源栈的时候生成,为UUID。 由于资源栈名仅仅在同一时间下唯一,即用户允许先生成一个叫HelloWorld的资源栈,删除,再重新创建一个同名资源栈。 对于团队并行开发,用户可能希望确保,当前我操作的资源栈就是我认为的那个,而不是其他队友删除后创建的同名资源栈。因此,使用ID就可以做到强匹配。 资源编排服务保证每次创建的资源栈所对应的ID都不相同,更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致,则返回400 最小长度:36 最大长度:36
共100000条