华为云用户手册

各手机厂商长文本智能信息模板差异 各手机厂商支持内容的差异 支持情况及规范要求参见表1表 表1 各手机厂商长文本类智能信息模板支持内容的差异 品牌 华为 小米 OPPO VIVO 魅族 长文本类素材规范 图片大小 宽高比16:9，最大大小2M，建议像素1120*372 / 宽高比16:9，最大大小2M，建议像素1120*372 / / 标题 1行，15字 1行，15字 正文 18行，350字 18行，350字 动参能力 √ / / / / 各手机厂商长文本类智能信息模板终端样例差异 图1 华为终端样例 图2 OPPO终端样式

各手机厂商智能信息模板应用差异有哪些？ 各手机厂商版式支持差异 表1 各手机厂商版式支持差异 各手机厂商版式支持能力 华为 小米 OPPO VIVO 魅族 支持情况一览表 模板样式 通知 √ √ √ √ × 图文 √ √ √ √ √ 红包 √ √ √ √ × 长文本 √ × √ × × 多图文 √ √ √ √ √ 单卡券/多卡券 √ × × × × 图片轮播 √ × √ √ × 个性化红包 √ × × × × 电商（单商品） √ × √ √ × 横滑 √ × √ × √ 电商（多商品） √ × × × × 视频图文/图文视频 √ × × × × 视频 √ × √ √ × 各手机厂商信箱展示差异 华为终端收件箱列表显示一行，小米、OPPO及VIVO收件箱列表显示两行。收件箱显示两行的终端，智能信息文案尽量用原短信文案，前置利益点。 智能信息短信在短链和签名报备的情况下，会优先推送至主要栏。 图1 华为终端样例 图2 小米终端样例 图3 OPPO终端样例 图4 vivo终端样例 父主题： 智能模板制作常见问题

模板用途/来源、图片、文案问题规范要求有哪些？ 模板用途问题 模板用途区分，规范示范如图1。 图1 模板用途规范样例 模板发送主体问题 模板发送主体要清晰。错误示范如图2所示，其中图片文案均未出现商家主体。正确示范如图3所示，商家主体在图片或文案显眼位置标识。 图2 错误示范样例 图3 正确示范样例 图片素材问题 合格图片：简洁美观重点突出 图4 合格图片样例 图5 合格图片样例 不合格图片：文字与图片元素重叠、图片模糊、小字多看不清、截断、白底 、大片留白区域、周围大片空白 图6 不合格图片样例：文字与图片元素重叠 图7 不合格图片样例：图片模糊、小字多看不清 图8 不合格图片样例：截断 图9 不合格图片样例：白底 、大片留白区域 图10 不合格图片样例：周围大片空白 文案合规问题 图片/文案涉及其他厂商 图11 错误样例：图片/文案涉及其他厂商 文案截断 图12 错误样例：文案截断 不可使用有明显诱导性的按钮（如手指、箭头等） 图13 错误样例：诱导性符号按钮 不可使用具有明显诱导性，且与实际使用场景不符的文案（如小贷类的已到账、待领取等强诱导性字眼） 图14 错误样例：诱导性不实文案/按钮 图14中“到账”与实际使用场景不服且包含手指/箭头等强诱导性符号。 父主题： 智能模板制作常见问题

各手机厂商图片轮播类智能信息模板差异 各手机厂商支持内容的差异 支持情况及规范要求参见表1。 表1 各手机厂商图片轮播类智能信息模板支持内容的差异 品牌 华为 小米 OPPO VIVO 魅族 图片轮播48:65模板制作素材规范 图片大小 宽高比48:65，最大大小2M，最小像素960*1300，建议像素1088*1473 / 宽高比48:65，最大大小2M，最小像素960*1300，建议像素1088*1473 宽高比48:65，最大大小2M，最小像素960*1300，建议像素1088*1473 / 标题 1行，17字 1行，17字 2行，30字 正文 3行，69字 2行，69字 3行，69字 图片轮播16:9模板制作素材规范 图片大小 宽高比16:9，最大大小2M，最小像素1088*612，建议像素1248*704 宽高比16:9，最大大小2M，最小像素1088*612，建议像素1248*704 宽高比16:9，最大大小2M，最小像素1088*612，建议像素1248*704 标题 1行，17字 1行，17字 2行，30字 正文 11行，253字 2行，69字 3行，69字 图片轮播1:1模板制作素材规范 图片大小 宽高比1:1，最大大小2M，最小像素1088*1088，建议像素1088*1088 宽高比1:1，最大大小2M，最小像素1088*1088，建议像素1088*1088 宽高比1:1，最大大小2M，最小像素1088*1088，建议像素1088*1088 标题 1行，17字 1行，17字 2行，30字 正文 11行，253字 2行，69字 3行，69字 动参能力 √ / √ √ / 各手机厂商图片轮播类智能信息模板终端样例差异 图1 华为终端样例 图2 OPPO终端样例 图3 VIVO终端样例

能否通过动态参数指定智能信息模板的图片、跳转链接、标题、内容？ 动态参数的作用是为了方便客户看到个性化内容，目前仅支持标题、文案和链接设置动参，不支持图片的动参。 动态参数的内容要求来源合法或有充分授权，不会出现不正当竞争行为或侵犯第三方的著作权、信息网络传播权等任何合法权益。用户在使用动态参数时应承诺所有素材内容与推送消息内容保持一致，不包含违法和不良信息内容；对于信息内容中人物的肖像权也已获得充分授权、可合法用于展示、介绍、宣传、推广、演示产品、服务、公司或与公司有关的其他事务。 父主题： 其他问题

KooMessage服务开通以后，是否还需要开通消息&短信（Message & SMS）服务？ 开通KooMessage服务会默认开通消息&短信服务，是可以使用消息&短信（Message & SMS）服务，消息&短信（Message & SMS）服务用于智能信息AIM的短信发送。如您不使用华为云短信发送通道进行智能消息AIM的发送，只使用智能信息AIM+的短链生成和解析，可关闭消息&短信（Message & SMS）服务。 父主题： 服务开通

KooMessage智能信息和普通短信的区别是什么？ 智能信息是通过手机终端增强技术和用户数据分析能力，以可交互的富媒体方式精准触达到最终消费者。可实现与用户应用交互、内容访问、信息查询、智能客服等实时互动。支持视频、高清图片、文字等多种媒体元素，支持浏览器内置访问、LBS、APP、快应用、服务号、快捷支付等应用交互能力，有效帮助企业客户与用户实现智能、快速、精准的营销互动沟通与服务。 父主题： 服务能力咨询

智能信息模板制作规范 智能信息模板有哪些 智能信息模板总体设计规范有哪些 各手机厂商智能信息模板应用差异有哪些？ 各手机厂商智能信息支持能力差异有哪些？ 各手机厂商智能信息模板审核差异有哪些？ 模板用途/来源、图片、文案问题规范要求有哪些？ 落地页一致性规范要求有哪些？ 参数填写规范要求有哪些？ 红包模板使用规范要求有哪些？ 高质量素材规范要求有哪些？ 通知类智能信息模板制作规范 图文类智能信息模板制作规范 红包类智能信息模板制作规范 个性化红包类智能信息模板制作规范 长文本类智能信息模板制作规范 多图文类智能信息模板制作规范 横滑卡片类智能信息模板制作规范 视频图文类和图文视频类智能信息模板制作规范 视频类智能信息模板制作规范 图片轮播类智能信息模板制作规范 电商类智能信息模板制作规范 电商（多商品）类智能信息模板制作规范 卡券类智能信息模板制作规范

状态码 表1 状态码 返回值 描述 200 OK 请求正常。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 416 Requested range not satisfiable 客户端请求的范围无效。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

响应示例 状态码： 200 successful operation { "edge_site" : { "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "name" : "测试站点", "description" : "测试站点：位于安徽", "region_id" : "cn-north-4", "project_id" : "060576838600d5762f2dc000470eb164", "availability_zone_id" : null, "enterprise_project_id" : "0", "status" : "initial", "location" : { "description" : "站点场地信息", "zone_code" : "CN", "address" : "安徽省 合肥市 瑶海区", "country" : "CN", "province" : "安徽省", "city" : "合肥市", "district" : "瑶海区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0, "installation" : "SUPPORT" } }, "created_at" : "2022-04-15T07:59:20.641Z", "updated_at" : null }}

请求示例 创建边缘小站，区域为cn-north-4（北京四），部署位置为中国/安徽省/合肥市/瑶海区，机房暂不确定是否满足条件，机柜暂无扩容计划，运输通道和机房门的高度或宽度不满足要求，可支持整柜安装，并入现有机柜组。 POST https://{ies_endpoint}/v1/{domain_id}/edge-sites{ "edge_site" : { "name" : "测试站点", "description" : "测试站点：位于安徽", "region_id" : "cn-north-4", "location" : { "description" : "站点场地信息", "zone_code" : "CN", "address" : "安徽省 合肥市 瑶海区", "country" : "CN", "province" : "安徽省", "city" : "合肥市", "district" : "瑶海区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0 } } }}

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 edge_site EdgeSiteDetail object 边缘小站详情 表8 EdgeSiteDetail 参数 参数类型 描述 id String 边缘小站ID domain_id String 边缘小站所属账号ID name String 边缘小站名称 description String 边缘小站描述 region_id String 边缘小站所属区域ID project_id String 边缘小站所属项目ID availability_zone_id String 边缘小站的可用区ID status String 边缘小站的部署状态 location LocationDetail object 场地详情 created_at String 边缘小站创建时间 updated_at String 边缘小站更新时间 表9 LocationDetail 参数 参数类型 描述 name String 场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段 description String 场地描述 zone_code String 场地所在地区 address String 部署位置 country String 场地所在国家（逐步下线，使用zone_code替代） province String 场地所在省/自治区/直辖市 city String 场地所在市/区 district String 场地所在区/县 condition Condition object 场地条件 表10 Condition 参数 参数类型 描述 environment Integer 机房环境条件 取值范围： 0：机房条件不属于上述任何一种情况 1：机房使用模块化数据中心方案进行建设 2：机房已通过国家级或行业级标准化认证 最小值：0 最大值：2 缺省值：0 space Integer 机柜空间条件 取值范围： 0：暂无扩容计划，不考虑额外余量 1：机柜余量相对充裕，可放置空间超过3柜 2：机柜余量相对紧张，可放置空间3柜以内 最小值：0 最大值：2 缺省值：0 transport Integer 运输条件 取值范围： 0：运输通道和机房门的高度或宽度不满足要求 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶 最小值：0 最大值：2 缺省值：0 installation String 整柜安装评估 取值范围： UNCLEAR：不清楚是否允许整柜安装，需要评估 UNSUPPORT：不允许整柜安装，需将设备放入现有机柜 SUPPORT：可支持整柜安装，并入现有机柜组 缺省值：UNCLEAR

操作步骤 查询支持边缘小站接入的区域列表并确认拟接入的区域ID。 接口相关信息 URI格式：GET /v1/{domain_id}/regions 接口详情请参见：查询支持的区域列表。 请求示例 GET https://{endpoint}/v1/{domain_id}/regions {endpoint}信息请从地区和终端节点获取。 {domain_id}信息获取方式参见获取帐号ID。 响应示例 状态码： 200 OK { "regions" : [ { "region_id" : "cn-north-9", "display_name" : "华北-乌兰察布一" }, { "region_id" : "cn-south-1", "display_name" : "华南-广州" } ]} 创建边缘小站。 接口相关信息 URI格式：POST /v1/{domain_id}/edge-sites 接口详情请参见：创建边缘小站 请求示例 POST https://{endpoint}/v1/{domain_id}/edge-sites {endpoint}信息请从地区和终端节点获取。 {domain_id}信息获取方式参见获取帐号ID。 请求Body体 {"edge_site": {"name": "test11111111","description": "teasra","region_id": "br-iaas-odin1","location": {"name": "test11111111111","description": "description","country": "CN","province": "安徽省","city": "合肥市","district": "瑶海区","condition": {"environment": 0,"space": 0,"transport": 0}}}} 响应示例 状态码： 200 OK {"edge_site": {"id": "cc89b1e5-521d-4a85-be83-e6f7217fc63e","domain_id": "2b76febbe5d34eac85d26435c1f15809","name": "test11111111","description": "teasra","region_id": "br-iaas-odin1","project_id": "060576838600d5762f2dc000470eb164","availability_zone_id": null,"status": "initial","location": {"name": "test11111111111","description": "description","country": "CN","province": "安徽省","city": "合肥市","district": "瑶海区","condition": {"environment": 0,"space": 0,"transport": 0}},"created_at": "2022-04-15T07:59:20.641Z","updated_at": null}}

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 IES.00001005 param is invalid. 请求参数不合法。 请参照产品文档，检查请求的参数后重试。 400 IES.00001008 quota is insufficient. 配额不足。 删除不用的资源或者提高配额后再创建。 400 IES.00011001 edge site name has already existed, can not create or update. 边缘小站名称已存在，无法创建或更新。 请更新参数后重试。 400 IES.00011007 edge site status, can not update properties location. 该状态的边缘小站，无法更新场地属性。 请检查小站ID后重试。 400 SYS.0400 Bad request 请求参数错误 请参照产品文档，检查请求的参数后重试。 401 SYS.0401 Unauthorized. 未经授权 请联系客服。 403 IES.00001003 not allowed to perform, please apply for beta permission 权限不足，请申请公测权限。 请申请公测权限。 403 IES.00011003 edge site of this status can not be deleted. 该状态的边缘小站无法被删除。 请检查小站ID后重试。 404 IES.00011002 edge site not exists. 边缘小站不存在。 请检查小站ID后重试。 404 IES.00021001 region id not exists. IES暂不支持该region。 请修改region或联系客服。 404 SYS.0404 Resource not Found 资源不存在 请检查资源ID后重试。 500 IES.00001001 parse token error, context is empty Token不正确 请修改token或联系客服。 500 IES.00001007 token is invalid. Token无效。 请修改token后重试。 500 IES.00011004 region not exists, can not create edge site. 无该region使用权限，无法创建边缘小站。 请修改region或联系客服。 500 IES.00011005 create edge site error. 创建边缘小站错误。 请联系客服。 500 SYS.0500 Internal service error. 内部服务错误。 请联系客服。 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas QuotaResources object 资源配额详情列表 表4 QuotaResources 参数 参数类型 描述 resources Array of QuotaDetail objects 资源配额列表 表5 QuotaDetail 参数 参数类型 描述 type String 资源类型 取值范围： edge_site：边缘小站 compute_device：计算设备 quota Integer 资源的总配额 约束：资源的默认配额数可以修改，默认配置：边缘小站（10） used Integer 已创建的资源个数 取值范围：0~quota值

响应示例 状态码： 200 successful operation { "edge_sites" : { "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "name" : "测试站点", "description" : "测试站点：位于安徽", "region_id" : "cn-north-4", "project_id" : "060576838600d5762f2dc000470eb164", "availability_zone_id" : null, "status" : "initial", "location" : { "description" : "站点场地信息", "zone_code" : "CN", "address" : "安徽省 合肥市 瑶海区", "country" : "CN", "province" : "安徽省", "city" : "合肥市", "district" : "瑶海区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0, "installation" : "SUPPORT" } }, "created_at" : "2022-04-15T07:59:20.641Z", "updated_at" : null }, "page_info" : { "current_count" : 1 }}

URI GET /v1/{domain_id}/edge-sites 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String path中租户的账号ID 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页的数量 最小值：1 最大值：2000 缺省值：2000 marker 否 String 分页标识 sort_key 否 Array 排序字段 sort_dir 否 Array 排序方式，取值范围： desc：降序 asc：升序 enterprise_project_id 否 Array 企业项目ID。可以使用该字段过滤某个企业项目下的边缘小站。 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。 若需要查询当前用户所有企业项目绑定的边缘小站，请传参all_granted_eps。 不传则查询全部。 id 否 Array 根据边缘小站ID查询，支持排序 name 否 Array 根据边缘小站名称查询（精确），支持排序 availability_zone_id 否 Array 根据边缘可用区ID查询 status 否 Array 根据边缘小站部署状态查询

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 edge_sites Array of EdgeSiteDetail objects 边缘小站列表。 page_info PageInfo object 分页信息 表5 EdgeSiteDetail 参数 参数类型 描述 id String 边缘小站ID domain_id String 边缘小站所属账号ID name String 边缘小站名称 description String 边缘小站描述 region_id String 边缘小站所属区域ID project_id String 边缘小站所属项目ID availability_zone_id String 边缘小站的可用区ID status String 边缘小站的部署状态 location LocationDetail object 场地详情 created_at String 边缘小站创建时间 updated_at String 边缘小站更新时间 表6 LocationDetail 参数 参数类型 描述 name String 场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段 description String 场地描述 zone_code String 场地所在地区 address String 部署位置 country String 场地所在国家（逐步下线，使用zone_code替代） province String 场地所在省/自治区/直辖市 city String 场地所在市/区 district String 场地所在区/县 condition Condition object 场地条件 表7 Condition 参数 参数类型 描述 environment Integer 机房环境条件 取值范围： 0：机房条件不属于上述任何一种情况 1：机房使用模块化数据中心方案进行建设 2：机房已通过国家级或行业级标准化认证 最小值：0 最大值：2 缺省值：0 space Integer 机柜空间条件 取值范围： 0：暂无扩容计划，不考虑额外余量 1：机柜余量相对充裕，可放置空间超过3柜 2：机柜余量相对紧张，可放置空间3柜以内 最小值：0 最大值：2 缺省值：0 transport Integer 运输条件 取值范围： 0：运输通道和机房门的高度或宽度不满足要求 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶 最小值：0 最大值：2 缺省值：0 installation String 整柜安装评估 取值范围： UNCLEAR：不清楚是否允许整柜安装，需要评估 UNSUPPORT：不允许整柜安装，需将设备放入现有机柜 SUPPORT：可支持整柜安装，并入现有机柜组 缺省值：UNCLEAR 表8 PageInfo 参数 参数类型 描述 next_marker String 下一页标识。 current_count Integer 当前页数量。

响应示例 状态码： 200 successful operation { "metric_data" : [ { "name" : "cpu_used", "value" : 136, "read_at" : "2022-04-28T08:15:00.428Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } }, { "name" : "cpu_total", "value" : 184, "read_at" : "2022-04-28T08:15:00.428Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } }, { "name" : "memory_used", "value" : 272, "read_at" : "2022-04-28T08:15:00.428Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } }, { "name" : "memory_total", "value" : 648, "read_at" : "2022-04-28T08:15:00.428Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } }, { "name" : "capacity_used", "value" : 5707, "read_at" : "2022-04-28T08:15:00.501Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } }, { "name" : "capacity_total", "value" : 113090, "read_at" : "2022-04-28T08:15:00.501Z", "dimension" : { "name" : "site_id", "value" : "7db2702e-4d18-478f-856b-11cbcf5f1dbc" } } ]}

URI GET /v1/{domain_id}/edge-sites/{site_id}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String path中租户的账号ID 最大长度：36 site_id 是 String 边缘小站ID 表2 Query参数 参数 是否必选 参数类型 描述 dim 否 String 指定维度查询 site_id: 按站点维度，查询站点下计算、存储资源容量信息 flavor: 按规格维度，查询站点下各flavor的计算资源使用情况 storage: 按存储维度，查询站点下各存储资源类型的使用情况 flavor_capacity: 按规格容量维度，查询站点下各规格可发放数量预测 缺省值：site_id

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 metric_data Array of MetricDataDetail objects 监控数据 表5 MetricDataDetail 参数 参数类型 描述 name String 监控指标名称，当前包含指标： cpu_used：该维度vCPU已使用核数，单位：个，支持维度：site_id，flavor cpu_available_total：用户可使用该维度vCPU总核数，单位：个，支持维度：site_id，flavor cpu_total：该维度vCPU总核数（包含HA等预留核数），单位：个，支持维度：site_id，flavor memory_used：该维度内存已使用量，单位：Gb，支持维度：site_id，flavor memory_available_total：用户可使用该维度内存总量，单位：Gb，支持维度：site_id，flavor memory_total：该维度内存总量（包含HA等预留内存量），单位：Gb，支持维度：site_id，flavor capacity_used：该维度块存储资源已使用量，单位：GiB，支持维度：site_id，storage capacity_available_total：用户可使用该维度块存储资源总容量（用户订购开通的存储容量），单位：GiB，支持维度：site_id，storage capacity_total：当前已订购的资源场景下该维度块存储资源最大容量（订购资源包含的存储容量可能大于用户已开通容量），单位：GiB，支持维度：site_id，storage available：该维度对应规格剩余可发放数量，单位：台，支持维度：flavor_capacity value Long 监控值 read_at String 记录更新时间 dimension dimension object 维度信息 表6 dimension 参数 参数类型 描述 name String 维度名称 value String 维度值

URI GET /v1/{domain_id}/regions 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String path中租户的账号ID 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页的数量 最小值：1 最大值：2000 缺省值：2000 marker 否 String 分页标识 sort_key 否 Array 排序字段 sort_dir 否 Array 排序方式，取值范围： desc：降序 asc：升序

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 regions Array of RegionDetail objects 区域列表 page_info PageInfo object 分页信息 表5 RegionDetail 参数 参数类型 描述 region_id String 区域ID display_name String 区域名称 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页标识。 current_count Integer 当前页数量。

响应示例 状态码： 200 successful operation { "edge_site" : { "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "name" : "测试站点", "description" : "测试站点：位于安徽", "region_id" : "cn-north-4", "project_id" : "060576838600d5762f2dc000470eb164", "availability_zone_id" : null, "status" : "initial", "location" : { "description" : "测试站点场地信息", "zone_code" : "CN", "address" : "广东省 深圳市 南山区", "country" : "CN", "province" : "广东省", "city" : "深圳市", "district" : "南山区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0, "installation" : "SUPPORT" } }, "created_at" : "2022-04-15T07:59:20.641Z", "updated_at" : null }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 edge_site EdgeSiteDetail object 边缘小站详情 表4 EdgeSiteDetail 参数 参数类型 描述 id String 边缘小站ID domain_id String 边缘小站所属账号ID name String 边缘小站名称 description String 边缘小站描述 region_id String 边缘小站所属区域ID project_id String 边缘小站所属项目ID availability_zone_id String 边缘小站的可用区ID status String 边缘小站的部署状态 location LocationDetail object 场地详情 created_at String 边缘小站创建时间 updated_at String 边缘小站更新时间 表5 LocationDetail 参数 参数类型 描述 name String 场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段 description String 场地描述 zone_code String 场地所在地区 address String 部署位置 country String 场地所在国家（逐步下线，使用zone_code替代） province String 场地所在省/自治区/直辖市 city String 场地所在市/区 district String 场地所在区/县 condition Condition object 场地条件 表6 Condition 参数 参数类型 描述 environment Integer 机房环境条件 取值范围： 0：机房条件不属于上述任何一种情况 1：机房使用模块化数据中心方案进行建设 2：机房已通过国家级或行业级标准化认证 最小值：0 最大值：2 缺省值：0 space Integer 机柜空间条件 取值范围： 0：暂无扩容计划，不考虑额外余量 1：机柜余量相对充裕，可放置空间超过3柜 2：机柜余量相对紧张，可放置空间3柜以内 最小值：0 最大值：2 缺省值：0 transport Integer 运输条件 取值范围： 0：运输通道和机房门的高度或宽度不满足要求 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶 最小值：0 最大值：2 缺省值：0 installation String 整柜安装评估 取值范围： UNCLEAR：不清楚是否允许整柜安装，需要评估 UNSUPPORT：不允许整柜安装，需将设备放入现有机柜 SUPPORT：可支持整柜安装，并入现有机柜组 缺省值：UNCLEAR

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 12 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），它告诉您服务正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

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不同，使用时请注意。