查询边缘业务详情 - ShowEdgeCloud
功能介绍
查询边缘业务详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/edgeclouds/{edgecloud_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
edgecloud_id |
是 |
String |
边缘业务ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
边缘业务ID。 |
|
name |
String |
边缘业务名称。 |
|
stacks |
Array of Stack objects |
边缘业务资源组。 |
|
coverage |
CoverageResp object |
边缘业务覆盖策略。 |
|
success_num |
Integer |
边缘业务成功创建的虚拟机数量。 |
|
failed_num |
Integer |
边缘业务创建失败的虚拟机数量。 |
|
status |
String |
边缘业务状态。 |
|
fail_reason |
FailReason object |
边缘业务失败的原因。 |
|
edge_regions |
Integer |
边缘业务支持的边缘区域数目,等同于边缘业务下所有实例的区域数目总和 |
|
description |
String |
描述。 |
|
create_at |
String |
创建时间。 |
|
update_at |
String |
修改时间。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
边缘资源组名称。 取值范围:只能由中文字符、大小写英文字母、数字及中划线、下划线组成,且长度为[1-48]个字符。 |
|
resources |
Array of Resource objects |
边缘业务的堆栈,即为资源组。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
边缘实例名称。 取值范围: 只能由中文字符、英文字母 (大小写)、数字及“_”、“-”、“.” 组成。 创建的边缘实例数量(count字段对应的值)大于1时,为区分不同边缘实例,创建过程中系统会自动在名称后加“-000x”的类似标记。
说明:
华为云边缘实例内部主机名 (hostname)命名规则遵循RFC 952和RFC 1123命名规范,建议使用a-zA-z或0-9以及中划线'-'组成的名称命名,' _' 将在边缘实例内部默认转化为'-'。
|
|
with_prefix |
Boolean |
是否自动添加名称前缀。
以name为iec为例: 不添加前缀时实例名称为:iec-0001 自动添加前缀实例名称为:IEC-ZS01-iec-0001 0001为创建边缘业务时根据实例个数自动添加的编号 |
|
image_ref |
String |
待发放边缘实例的系统镜像,需要指定已创建镜像的ID。
说明:
镜像的ID可以从控制台或者参考本文档的“查询边镜像列表”的章节获取。
|
|
flavor_ref |
String |
边缘实例的系统规格的ID。 |
|
admin_pass |
String |
如果需要使用密码方式登录边缘实例,可使用admin_pass字段指定边缘实例管理员账户初始登录密码。其中,Linux管理员账户为root,Windows管理员账户为Administrator。 密码复杂度要求:
说明:
目前边缘实例不支持创建后设置密码,不设置此参数会导致实例无法登录。
|
|
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文件。 更多关于待注入用户数据的信息,请参见《弹性云服务器用户指南 》的“用户数据注入”章节。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc_id |
String |
边缘网络ID。 约束:
|
|
nic_num |
Integer |
边缘实例绑定的网卡数量。 约束:一台边缘实例最少绑定一张网卡,最多绑定8张网卡。 |
|
allowed_address_pairs |
Array of AllowedAddressPair objects |
IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ip_address |
String |
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地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sharetype |
String |
带宽类型,现支持WHOLE类型,即共享带宽,其他类型不支持。 |
|
size |
Integer |
带宽(Mbit/s)。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
系统盘大小,容量单位为GB,输入大小范围为[40,100]。 |
|
volume_type |
String |
边缘实例系统盘对应的磁盘类型,需要与站点所提供的磁盘类型相匹配。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
数据盘大小,容量单位为GB,输入大小范围为[1,500]。 |
|
volume_type |
String |
边缘实例数据盘对应的磁盘类型,需要与站点所提供的磁盘类型相匹配。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
coverage_policy |
String |
区域调度策略,只支持centralize/discrete。
|
|
coverage_level |
String |
区域分布层级,只支持area/prov/city/site。
约束: 站点层级,coverage_policy上仅支持'centralize',coverage_sites中'site'字段仅支持使用ID(站点ID,通过“查询边缘站点列表”获取),不支持name。 |
|
coverage_sites |
Array of CoverageSiteResp objects |
区域及购买数量列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
site |
String |
站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意:本字段区分大小写)。 |
|
demands |
Array of DemandResp objects |
租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。 |
|
i18n_site |
String |
覆盖区域的国际化信息。 |
请求示例
GET https://{endpoint}/v1/edgeclouds/27101e92-49a7-11eb-8a8a-fa1640495574
响应示例
状态码:200
OK
{
"id" : "27101e92-49a7-11eb-8a8a-fa1640495574",
"name" : "edgecloud1",
"stacks" : {
"name" : "stack-fo09-xi_a-001",
"resources" : [ {
"name" : "edgeinstance1",
"image_ref" : "00000000-0000-0000-0000-000000000002",
"flavor_ref" : "c6.large.2",
"user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQzOEVORTckaTJ6Li9ibzZMUGlUT3VFVE5KbmxNdC9yMmJSNlhyOC81S3BndWtNU0xhLmhiVlFJNkY3T25sUS5ucVM0SXpmVEhSU0ZHN3lBeHBiakxlNkUwYjE1YjEnIHwgY2hwYXNzd2QgLWU7",
"admin_pass" : "******",
"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",
"i18n_site" : "西安市",
"demands" : [ {
"demand_count" : 1
} ]
} ]
},
"success_num" : 0,
"failed_num" : 1,
"status" : "failed",
"edge_regions" : 1,
"create_at" : "2020-12-29T07:26:22.866644Z",
"update_at" : "2020-12-29T07:26:24.728957Z"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。