网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

查询部署计划列表

更新时间:2024-01-02 GMT+08:00
分享

功能介绍

查询部署计划列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/deployments

表1 Query参数

参数

是否必选

参数类型

描述

edgecloud_id

String

查询条件,边缘业务ID。

id

String

查询条件,部署计划ID。

limit

Integer

查询返回部署计划列表当前页面的数量。

最小值:0

最大值:1000

offset

Integer

偏移量。 当前偏移量,默认为0。

status

String

查询条件,部署计划状态,现只包含如下值:

  • open:部署计划处于未执行状态,可执行部署计划进行部署

  • closed:部署计划已关闭,不可部署。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

部署计划列表的总和。

deployments

Array of Deployment objects

部署计划列表。

表4 Deployment

参数

参数类型

描述

id

String

部署计划ID。

distribution

Array of Distribution objects

部署位置信息列表

edgecloud

DeploymentEdgecloud object

待部署的边缘业务。

表5 Distribution

参数

参数类型

描述

area

String

所在大区名称。

city

String

所在城市名称。

operator

String

所属运营商名称。

province

String

所属省份名称。

site_id

String

站点ID。

pool_id

String

线路ID。多线路场景下,将在该线路下创建弹性公网IP。

stack_count

Integer

资源组配置模板数目

city_short_name

String

城市简称。

ipv6_enable

Boolean

创建边缘实例是否开启IPv6。

ipv6_bandwidth_enable

Boolean

创建IPv6边缘实例是否支持公网访问。

pool_id_v6

String

IPv6线路ID。IPv6场景下,使用该线路下的子网分配IPv6端口。

表6 DeploymentEdgecloud

参数

参数类型

描述

id

String

边缘业务ID。

name

String

边缘业务名称。

stacks

Stack object

边缘业务资源组。

description

String

边缘业务描述,最大支持255字节。

coverage

Coverage object

边缘业务覆盖策略。

表7 Stack

参数

参数类型

描述

name

String

边缘资源组名称。 取值范围:只能由中文字符、大小写英文字母、数字及中划线、下划线组成,且长度为[1-48]个字符。

最小长度:1

最大长度:48

resources

Array of Resource objects

边缘业务的堆栈,即为资源组。

表8 Resource

参数

参数类型

描述

name

String

边缘实例名称。 取值范围: 只能由中文字符、英文字母 (大小写)、数字及“_”、“-”、“.” 组成。 创建的边缘实例数量(count字段对应的值)大于1时,为区分不同边缘实例,创建过程中系统会自动在名称后加“-000x”的类似标记。

说明:

华为云边缘实例内部主机名 (hostname)命名规则遵循RFC 952和RFC 1123命名规范,建议使用a-zA-z或0-9以及中划线'-'组成的名称命名,' _' 将在边缘实例内部默认转化为'-'。

最小长度:1

最大长度:48

with_prefix

Boolean

是否自动添加名称前缀。

  • with_prefix为false时不拼接IEC前缀

  • with_prefix不传或者传true时拼自动IEC前缀

以name为iec为例: 不添加前缀时实例名称为:iec-0001 自动添加前缀实例名称为:IEC-ZS01-iec-0001 0001为创建边缘业务时根据实例个数自动添加的编号

缺省值:true

image_ref

String

待发放边缘实例的系统镜像,需要指定已创建镜像的ID。

说明:

镜像的ID可以从控制台或者参考本文档的“查询边镜像列表”的章节获取。

flavor_ref

String

边缘实例的系统规格的ID。

admin_pass

String

如果需要使用密码方式登录边缘实例,可使用admin_pass字段指定边缘实例管理员帐户初始登录密码。其中,Linux管理员帐户为root,Windows管理员帐户为Administrator。

密码复杂度要求:

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。

  • 密码不能包含用户名或用户名的逆序。

  • Windows系统密码不能包含用户名或用户名的逆序,不能包含用户名中超过两个连续字符的部分。

说明:

目前边缘实例不支持创建后设置密码,不设置此参数会导致实例无法登录。

最小长度:8

最大长度:26

key_name

String

密钥对名称。

net_config

NetConfig object

实例的边缘网络配置。 包含了边缘网络的网段信息和子网数目信息。

bandwidth

BandwidthConfig object

实例的带宽参数。 IEC服务现在提供共享带宽服务,暂不支持其他类型带宽。

说明:

创建边缘业务时指定实例同步创建EIP则需通过此参数指定。

root_volume

RootVolume object

边缘实例对应系统盘相关配置。

data_volumes

Array of DataVolume objects

边缘实例对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。

约束:目前边缘实例最多可挂载2块数据盘

count

Integer

边缘实例数量。 不传该字段时默认取值为1。

security_groups

Array of SecurityGroupOption objects

边缘业务对应安全组信息。

user_data

String

创建边缘实例过程中注入用户数据。支持注入文本、文本文件或gzip文件。 更多关于待注入用户数据的信息,请参见《弹性云服务器用户指南 》的“用户数据注入”章节。

表9 NetConfig

参数

参数类型

描述

vpc_id

String

边缘网络ID。

约束:

  • 创建边缘业务仅支持使用系统规划的虚拟私有云。

nic_num

Integer

边缘实例绑定的网卡数量。

约束:一台边缘实例最少绑定一张网卡,最多绑定8张网卡。

最小值:1

最大值:8

allowed_address_pairs

Array of AllowedAddressPair objects

  • 功能说明:IP/Mac对列表

  • 约束: IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关

表10 AllowedAddressPair

参数

参数类型

描述

ip_address

String

  • 功能说明:IP地址

  • 约束: IP地址不支持“0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”,表示关闭源目地址检查开关。 被绑定的边缘实例网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

mac_address

String

MAC地址

表11 BandwidthConfig

参数

参数类型

描述

sharetype

String

带宽类型,现支持WHOLE类型,即共享带宽,其他类型不支持。

size

Integer

带宽(Mbit/s)。

表12 RootVolume

参数

参数类型

描述

size

Integer

系统盘大小,容量单位为GB,输入大小范围为[40,100]。

最小值:40

最大值:100

volume_type

String

边缘实例系统盘对应的磁盘类型,需要与站点所提供的磁盘类型相匹配。

表13 DataVolume

参数

参数类型

描述

size

Integer

数据盘大小,容量单位为GB,输入大小范围为[1,500]。

最小值:1

最大值:500

volume_type

String

边缘实例数据盘对应的磁盘类型,需要与站点所提供的磁盘类型相匹配。

表14 SecurityGroupOption

参数

参数类型

描述

id

String

边缘实例的安全组,会对边缘实例中配置的网卡生效。需要指定已有安全组的ID。不填写时选择默认安全组

表15 Coverage

参数

参数类型

描述

coverage_policy

String

区域调度策略,只支持centralize/discrete。

  • centralize:代表城市集中策略,指定该策略,边缘业务创建时会保证将所有实例都发放在同一个站点。

  • discrete:代表城市分散,指定该策略,边缘业务创建时,尽量保证所有实例都分散发放在不同站点。

coverage_level

String

区域分布层级,只支持area/prov/city/site。

  • area:大区,用户的资源会在指定大区下发放。

  • prov:省份,用户的资源会在指定省份下发放。

  • city:城市,用户的资源会在指定城市下发放。

  • site:站点级别。

约束:

站点层级,coverage_policy上仅支持'centralize',coverage_sites中'site'字段仅支持使用ID(站点ID,通过“查询边缘站点列表”获取),不支持name。

coverage_sites

Array of CoverageSite objects

区域及购买数量列表。

表16 CoverageSite

参数

参数类型

描述

site

String

站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意:本字段区分大小写)。

demands

Array of Demand objects

租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。

表17 Demand

参数

参数类型

描述

operator

String

所属运营商。

demand_count

Integer

站点需要发放的资源(组)总数。

说明:

实际发放实例数量为count*demand_count。

最小值:1

最大值:10

pool_id

String

弹性公网IP池。 多线路场景下,将在该弹性公网IP池下创建弹性公网IP。

说明:

覆盖规则为省级/大区时不支持指定线路ID创建边缘业务。

bandwidth_type

String

带宽类型。 如果当前带宽类型下没有带宽,自动在该带宽类型下创建带宽

pool_id_v6

String

指定IPv6线路,使用该线路下的子网分配IPv6端口。 如果该线路下没有关联启用IPv6的子网,则创建新的子网。

ipv6_bandwidth_enable

Boolean

使用IPv6带宽。 边缘实例是否开启IPv6公网访问能力。如果该IPv6线路没有可用的带宽,则创建新的带宽。

ipv6_bandwidth_type

String

带宽类型。 边缘实例开启IPv6访问公网能力后,如果当前带宽类型下没有带宽,自动在该带宽类型下创建带宽

请求示例

GET https://{endpoint}/v1/deployments

响应示例

状态码: 200

OK

{
  "count" : 1,
  "deployments" : [ {
    "id" : "87b9a88c-499d-11eb-8a8a-fa1640495574",
    "edgecloud" : {
      "name" : "edgecloud1",
      "stacks" : {
        "name" : "stack-fo09",
        "resources" : [ {
          "name" : "edgeinstance1",
          "image_ref" : "00000000-0000-0000-0000-000000000002",
          "flavor_ref" : "c6.large.2",
          "user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQzOEVORTckaTJ6Li9ibzZMUGlUT3VFVE5KbmxNdC9yMmJSNlhyOC81S3BndWtNU0xhLmhiVlFJNkY3T25sUS5ucVM0SXpmVEhSU0ZHN3lBeHBiakxlNkUwYjE1YjEnIHwgY2hwYXNzd2QgLWU7",
          "net_config" : {
            "vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4",
            "nic_num" : 1
          },
          "count" : 1,
          "root_volume" : {
            "volume_type" : "SATA",
            "size" : 100
          },
          "security_groups" : [ {
            "id" : "153133f5-2b16-11eb-a594-fa16408859a1"
          } ]
        } ]
      },
      "coverage" : {
        "coverage_policy" : "centralize",
        "coverage_level" : "city",
        "coverage_sites" : [ {
          "site" : "xi'an",
          "demands" : [ {
            "operator" : "",
            "pool_id" : "",
            "demand_count" : 1
          } ]
        } ]
      }
    },
    "distribution" : [ {
      "site_id" : "74a75ed3-cfb9-11ea-a0c3-fa1640495574",
      "area" : "north",
      "province" : "shaanxi",
      "city" : "xi'an",
      "operator" : "bgp",
      "pool_id" : "5_bgp_edgecloud-site4_0",
      "stack_count" : 1,
      "city_short_name" : ""
    } ]
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容