华为云用户手册

配置字段索引 创建字段索引时，最多支持添加500个字段。其中JSON类型字段，最多支持添加100个子字段。 设置快速分析采样条数，默认值10万条，最小值为10万条，最大值1000万条。通过采样快速统计字段值取值分布，并非对全量数据进行分析，采样条数越多分析数据越慢。 自动配置字段索引。在索引配置页面的字段索引下方，单击“自动配置”， 云日志服务LTS 会根据近15分钟的第一条日志内容或常见内置保留字段（例如hostIP、hostName、pathFile）自动生成字段索引，您可以根据自己的需要增加或者删除字段。 在索引配置页面单击“自动配置”时，默认获取最近15分钟的原始日志和内置字段的交集，LTS自动将原始日志和内置字段的交集、当前结构化字段、tag字段一起组成字段索引下方的表格数据。 若15分钟内没有原始日志，则获取hostIP、hostName、pathFile、结构化字段、tag字段结合共同组成字段索引下方的表格数据。 E CS 接入选择结构化配置时，进入索引配置页面，若没有单击“自动配置”，则会自动加上如下字段：category、 hostName、hostId、 hostIP、 hostIPv6、 pathFile，添加字段时，若某个字段已存在于索引配置，则不会重复添加。 CCE接入选择结构化配置时，进入索引配置页面，若没有单击“自动配置”，则会自动加上如下字段：category、 clusterId、 clusterName、 nameSpace、 podName、 containerName、 appName、 hostName、 hostId、 hostIP、 hostIPv6、 pathFile，添加字段时，若某个字段已存在于索引配置，则不会重复添加。 单个添加字段索引。在索引配置页面的字段索引下方，单击“添加字段”，配置字段索引。具体的参数配置请参考表3。 字段索引的参数配置仅对该字段生效。 当添加的字段在日志内容中不存在时，则配置的该索引字段无效。 表3 自定义字段索引配置参数 参数 说明 字段名称 日志字段名称，例如示例日志中的level。 字段名称只支持输入英文、数字、中划线、下划线及小数点，不能以小数点开头或结尾且不能以双下线结尾。 日志服务默认会对部分内置保留字段开启字段索引，请参见内置保留字段。 若是内置字段，在字段名称后会显示“内置”字眼，方便用户识别。 执行操作 显示字段的添加状态：新增、不修改、修改、删除。索引字段有变动后，单击“修改对比”，即可查看原配置内容与修改后配置内容的差异。 显示新增的字段不支持修改执行操作。 修改类型、别名、大小写敏感、自定义分词符、特殊分词符、包含中文、快速分析时，会与原索引配置中的字段进行对比，若任意一项不同，则执行操作变为“修改”。 索引配置单击确定后，不会保存执行操作为“删除”的字段。 在字段索引下方的搜索框，支持按字段名称、执行操作、类型搜索字段。 勾选多个字段后，单击“批量配置”，支持批量配置如下操作：执行操作、类型、大小写敏感、自定义分词符、特殊分词符、包含中文、快速分析。 类型 日志字段值（Value）的数据类型，可选值为string、long、float、json。 long类型和float类型不支持设置大小写敏感、包含中文、分词符。 别名 支持为字段名称设置别名，合理设置字段别名可以显著提高日志的可读性、可维护性和查询效率。 设置别名后，只支持使用别名进行SQL搜索分析，不支持使用别名进行关键字搜索。 说明： 该功能仅支持华北-北京四、华北-乌兰察布一、华东-上海一、中国-香港、亚太-新加坡区域，其他局点暂不支持该功能。 大小写敏感 查询时是否区分英文字母的大小写。 打开大小写敏感开关，则查询时区分大小写。例如示例日志message字段中含有Know，那么您只能使用message:Know才能查询到该日志。 关闭大小写敏感开关，则查询时不区分大小写。例如示例日志message字段中含有Know，那么您使用关键字message:KNOW和message:know都能查到该日志。 自定义分词符 根据指定分词符，将日志内容拆分成多个词。当默认设置不能满足您的需求时，您可以自定义设置分词符。 如果设置分词符为空，则字段值将被当成一个整体，您只能通过完整字符串或模糊查询查找对应的日志。 例如示例日志message字段内容为：I Know 今天是星期一。 如果不设置任何分词符，整条日志被作为一个词I Know 今天是星期一，您只能通过完整字符串message:I Know 今天是星期一或模糊查询message:I Know 今天是*查找该日志。 如果设置分词符为空格，则原始日志被拆分为I、Know、今天是星期一3个词，您通过任意一个词或词的模糊查询都可以找到该日志，例如message:Know或message:今天是星期一。 特殊分词符 单击“添加特殊分词符”，参考ASCII码对照表输入ASCII值。 包含中文 查询时是否区分中英文。 打开包含中文开关后，如果日志中包含中文，默认按照一元分词法拆分中文内容，按照分词符的设置拆分英文内容。 一元分词是指将中文字符串拆分为单个独立的中文字。 使用一元分词符的优点是对海量日志分词效率高，其他中文分词方法对写入速度影响大。 打开包含中文功能，会对中文使用一元分词（每个汉字单独分词），如果需要更精确的搜索结果，请用短语搜索，语法为：#"待搜索的短语"。 关闭包含中文开关后，按照分词符的设置拆分所有内容。 例如示例日志message字段内容为：I Know 今天是星期一。 关闭包含中文开关后，按照分词符的设置拆分英文内容，日志会被拆分为I、Know、今天是星期一，您可以通过message:Know或message:今天是星期一查找该日志。 打开包含中文开关后，日志服务后台分词器将日志拆分为I、Know、今、天、是、星、期、一，您通过message:Know或message:今天等词都可以查找到该日志。 快速分析 默认为开启状态，开启后，可以对字段值做采样统计，请参见创建快速分析。 快速分析的原理是对搜索命中的日志采样10万条进行数据统计，不是全量统计。 快速分析的字段长度最大为2000字节。 快速分析字段展示前100条数据。 操作 单击，删除添加的自定义字段。 图3 批量配置 完成后，单击“确定”。

索引类型 云日志 服务LTS支持全文索引和字段索引，详细请参考表1。 表1 索引类型 索引类型 说明 全文索引 开启全文索引后，日志服务根据您设置的分词符将整条日志所有字段值拆分成多个词并构建索引。 用户上传的自定义标签（label）字段，不包含在全文索引中，如果您需要搜索自定义标签字段，请添加对应的字段索引。 LTS内置保留字段，不包含在全文索引中，您需要通过字段索引Key:Value的方式进行搜索，请参考内置保留字段。 字段索引 配置字段索引后，您可以指定字段名称和字段值（Key:Value）进行查询，缩小查询范围。 日志服务默认为部分内置保留字段创建字段索引，请参考内置保留字段。 如果您的某个字段单独配置了字段索引，那么该字段值的分词符以字段索引配置为准。 结构化配置中的快速分析列已被移除，如果您要使用快速分析功能，则必须配置字段索引且开启对应字段的快速分析按钮。 例如以下日志示例，如果配置了level和status两个字段索引，其中level是string类型，字段值是error，单独配置了分词符，status是long类型，不需要配置分词符；您可以使用level:error的方式精确搜索level字段值为error的所有日志。 例如以下日志示例，云日志服务LTS会默认为hostName、hostIP、pathFile这些内置保留字段创建字段索引。 以下是一条典型日志示例，content字段值是日志原文，使用分隔符逗号将原始日志解析成3个字段level、status、message。 示例日志中的hostName、hostIP、pathFile是常见的内置保留字段，详细内置字段请参考内置保留字段。 { "hostName":"epstest-xx518", "hostIP":"192.168.0.31", "pathFile":"stdout.log", "content":"error,400,I Know XX", "level":"error", "status":400, "message":"I Know XX" }

漏洞管理服务的扫描IP有哪些？ 如果您的网站设置了防火墙或其他安全策略，将导致漏洞管理服务的扫描IP被当成恶意攻击者而误拦截。因此，在使用漏洞管理服务前，请您将以下扫描IP添加至网站访问的白名单中： 119.3.232.114，119.3.237.223，124.70.102.147，121.36.13.144，124.70.109.117，139.9.114.20，119.3.176.1，121.37.207.185，116.205.135.49，110.41.36.44，139.9.57.171，139.9.1.44，121.27.200.40 漏洞管理服务会模拟客户端使用随机端口连接被测试设备，建议放通来自漏洞管理服务这些ip的全量端口。 父主题： 产品咨询类

挂载的并行文件系统如何让其他用户访问？ 一般情况下，只有执行挂载命令的用户有访问挂载目录的权限。 如果要允许其他用户访问挂载目录，可以在obsfs挂载命令中指定allow_other参数，命令示例： ./obsfs filesystem001 /mnt/mount_path/ -o url=obs.cn-north-1.myhuaweicloud.com -o passwd_file=/etc/passwd-obsfs -o big_writes -o max_write=131072 -o allow_other -o use_ino

创建StarRocks集群 登录 表格存储服务 管理控制台。 单击管理控制台左上角的，选择区域。 单击右上角的购买集群按钮，进入“购买集群”页面。 表1 区域 参数 参数说明 区域 集群的工作区域。 选择集群节点实际工作区域。 有关区域的详细信息，请参见地区和终端节点。 可用区域 选择集群工作区域下关联的可用区。目前支持的可用区请参见区域和可用区。 计费模式 计费模式支持按需付费。 表2 集群和网络配置 参数 参数说明 名称 集群的名称。 集群名称在4位到32位之间，必须以字母开头，可以包含字母、数字或者中划线，不能包含其他的特殊字符，不区分大小写。 虚拟私有云 VPC即虚拟私有云，是通过逻辑方式进行网络隔离，提供安全、隔离的网络环境。 默认即可。如果没有虚拟私有云，请单击“查看虚拟私有云”进入虚拟私有云，创建一个新的虚拟私有云。 子网 指定虚拟私有云的一个子网。 集群使用子网实现与其他网络的隔离，并独享所有网络资源，以提高网络安全。 安全组 安全组用来实现安全组内和安全组间弹性云服务器的访问控制，加强弹性云服务器的安全保护。用户可以在安全组中定义各种访问规则，这些规则可以限定弹性云服务器的哪些端口或者协议可以访问，这些访问规则可以作用在进出虚拟机的网络访问上。当弹性云服务器加入该安全组后，即受到这些访问规则的保护。不属于该安全组的弹性云服务器，是无法同安全组内的弹性云服务器通信的。 您可以选择使用已有的安全组，或者单击“查看安全组”创建新的安全组。 关于安全组的更多信息，请参见《虚拟私有云用户指南》中的安全组。 数据引擎 选择需要创建的数据组件类型。 StarRocks内核版本 组件引擎版本。 表3 FE节点配置 参数 参数说明 计算规格 请根据业务需求合理选择计算规格。在计算规格列表中展示了每一种计算规格单个节点的CPU、内存和建议使用场景。 说明： 支持的计算规格： 8U16G 16U32G 32U64G 64U128G 4U16G 8U32G 16U64G 32U128G 64U256G 存储规格 选StarRocks计算节点的磁盘规格、容量。 说明： 支持的存储规格： 高IO。 通用型SSD。 超高IO。 极速型SSD。 容量范围为200~2000GB/节点。 节点数量 选择集群中的节点个数。 支持的节点数范围3个或5个。 表4 BE节点配置 参数 参数说明 计算规格 请根据业务需求合理选择计算规格。在计算规格列表中展示了每一种计算规格单个节点的CPU、内存和建议使用场景。 说明： 支持的计算规格： 8U16G 16U32G 32U64G 64U128G 4U16G 8U32G 16U64G 32U128G 64U256G 存储规格 选StarRocks计算节点的磁盘规格、容量。 说明： 支持的存储规格： 高IO。 通用型SSD。 超高IO。 极速型SSD。 容量范围为400~10000GB/节点。 节点数量 选择集群中的节点个数。 支持的节点数范围3~100。 表5 用户名密码参数 参数 参数说明 企业项目 企业项目管理帮助您将相关的资源（如具有相同使用用途的资源）集中在一起，按企业项目的方式来管理云资源。 说明： 当企业业务发生变化，原用户不再拥有企业项目的使用权限时，可将这些用户与该企业项目的关联关系删除。 可进行单个删除和批量删除。 当用户与企业项目的关联关系被删除后，该用户将无法管理该企业项目，如需再次使用，需要重新给该用户关联企业项目。 用户名 管理用户，用于连接集群，默认为admin，不可修改。 密码 设置admin用户密码。 密码复杂度要求如下： 8~12个字符。 至少包含以下字符中的4种：大写字母，小写字母、数字、特殊字符（$@!%*?&）。 不能与用户名或倒序用户名相同。 强弱密码检查。 说明： 请妥善保管并定期更新密码，避免安全风险。 确认密码 再次输入admin用户密码。 是否开启Broker进程 是否打开Broker进程，用于给客户做数据导入场景， 仅支持创建时开启。 配置好参数，单击“立即购买”。 进“规格详情”页面，确认集群规格订单信息，单击“提交”，成功提交集群创建任务。 单击“返回集群管理列表”，可以查看到集群创建的状态。 集群创建需要时间，请您耐心等待。所创集群的初始状态为“创建中”，创建成功后状态更新为“服务中”。

Step2 准备脚本文件并上传至OBS中 准备本案例所需训练脚本mindspore-verification.py文件和Ascend的启动脚本文件（共5个）。 训练脚本文件具体内容请参见训练mindspore-verification.py文件。 Ascend的启动脚本文件包括以下5个，具体脚本内容请参见Ascend的启动脚本文件。 run_ascend.py common.py rank_table.py manager.py fmk.py mindspore-verification.py和run_ascend.py脚本文件在创建训练作业时的“启动命令”参数中调用，具体请参见启动命令。 run_ascend.py脚本运行时会调用common.py、rank_table.py、manager.py、fmk.py脚本。 上传训练脚本mindspore-verification.py文件至OBS桶的“obs://test-modelarts/ascend/demo-code/”文件夹下。 上传Ascend的启动脚本文件（共5个）至OBS桶的“obs://test-modelarts/ascend/demo-code/run_ascend/”文件夹下。

Step5 在ModelArts上创建Notebook并调试 将上传到SWR上的镜像注册到ModelArts的镜像管理中。 登录ModelArts管理控制台，在左侧导航栏中选择“镜像管理 ”，单击“注册镜像”，根据界面提示注册镜像。注册后的镜像可以用于创建Notebook。 在Notebook中使用自定义镜像创建Notebook并调试，调试成功后，保存镜像。 在Notebook中使用自定义镜像创建Notebook操作请参见基于自定义镜像创建Notebook实例。 保存Notebook镜像操作请参见保存Notebook镜像环境。 已有的镜像调试成功后，再使用ModelArts训练模块训练作业。

训练mindspore-verification.py文件 mindspore-verification.py文件内容如下： import os import numpy as np from mindspore import Tensor import mindspore.ops as ops import mindspore.context as context print('Ascend Envs') print('------') print('JOB_ID: ', os.environ['JOB_ID']) print('RANK_TABLE_FILE: ', os.environ['RANK_TABLE_FILE']) print('RANK_SIZE: ', os.environ['RANK_SIZE']) print('ASCEND_DEVICE_ID: ', os.environ['ASCEND_DEVICE_ID']) print('DEVICE_ID: ', os.environ['DEVICE_ID']) print('RANK_ID: ', os.environ['RANK_ID']) print('------') context.set_context(device_target="Ascend") x = Tensor(np.ones([1,3,3,4]).astype(np.float32)) y = Tensor(np.ones([1,3,3,4]).astype(np.float32)) print(ops.add(x, y))

Step1 创建OBS桶和文件夹 在OBS服务中创建桶和文件夹，用于存放样例数据集以及训练代码。如下示例中，请创建命名为“test-modelarts”的桶，并创建如表1所示的文件夹。 创建OBS桶和文件夹的操作指导请参见创建桶和新建文件夹。 请确保您使用的OBS与ModelArts在同一区域。 表1 OBS桶文件夹列表 文件夹名称 用途 obs://test-modelarts/ascend/demo-code/ 用于存储Ascend训练脚本文件。 obs://test-modelarts/ascend/demo-code/run_ascend/ 用于存储Ascend训练脚本的启动脚本。 obs://test-modelarts/ascend/log/ 用于存储训练日志文件。

场景描述 目标：构建安装如下软件的容器镜像，并在ModelArts平台上使用Ascend规格资源运行训练作业。 ubuntu-18.04 cann-8.0.0 (商用版本) python-3.7.13 mindspore-2.1.1 本教程以cann-8.0.0、mindspore-2.1.1为例介绍。 本示例仅用于示意Ascend容器镜像制作流程，且在匹配正确的Ascend驱动/固件版本的专属资源池上运行通过。

使用限制 单账号跟踪的事件可以通过 云审计 控制台查询。多账号的事件只能在账号自己的事件列表页面去查看，或者到组织追踪器配置的OBS桶中查看，也可以到组织追踪器配置的 CTS /system日志流下面去查看。 用户通过云审计控制台只能查询最近7天的操作记录。如果需要查询超过7天的操作记录，您必须配置转储到 对象存储服务 （OBS）或云日志服务（LTS），才可在OBS桶或LTS日志组里面查看历史事件信息。否则，您将无法追溯7天以前的操作记录。 云上操作后，1分钟内可以通过云审计控制台查询管理类事件操作记录，5分钟后才可通过云审计控制台查询数据类事件操作记录。 CTS新版事件列表不显示数据类审计事件，您需要在旧版事件列表查看数据类审计事件。 云审计控制台对用户的操作事件日志保留7天，过期自动删除，不支持人工删除。

播放音视频 上传到点播服务的音视频可以在控制台进行预览播放，也可以通过使用第三方播放器进行播放。 控制台预览：在音视频管理界面，单击视频封面，在弹出的播放器中单击播放图标，即可开始预览播放。 在控制台预览播放音视频，需确保已开启该 域名 的HTTPS安全加速，并上传HTTPS证书。 播放器播放：在音视频管理界面，单击视频行右侧的“管理”，选择“播放地址”页签，在“操作”列单击复制播放URL，将复制的播放URL输入到播放器中进行播放，例如，使用VLC播放器。

全局设置（可选） 可选配置，若您对上传的音视频有转码、水印、加密、 消息通知 的需求，您可以在上传音视频文件前完成相关配置，然后在上传时或上传后使用模板进行处理。 设置转码模板 上传音视频时默认按照系统模板组转码，若您需要上传音视频时自定义转码，请参考转码设置创建自定义转码模板组。您也可以参考配置转码模板的视频指导进行操作。 设置视频水印 视频水印在转码过程中压制，如您需要使用视频水印，请参考水印设置配置水印模板并启用。 如果在全局设置中添加了视频水印模板并启用，则上传的视频默认压制水印。如需对新上传视频取消使用水印，请回到全局设置界面取消水印启用。 安全设置 为保障视频安全，华为云点播服务提供内容加密能力，若您需要，请参考安全设置配置加密参数。配置加密参数后，还需在配置转码模板时开启加密开关才能对视频内容进行加密，请参考转码设置开启加密开关。 分类设置 若您需要对已上传视频进行分类，请参考分类设置配置视频分类。 消息订阅 若您需要对任务执行状态进行实时通知，请参考消息订阅设置。

配置域名 当前系统域名资源已分配完，若您在开通点播服务后未分配有系统域名，则需要将已备案的域名添加到点播服务中才能进行媒资加速分发。 登录 视频点播 控制台。 在左侧导航栏中，选择“域名管理”，进入域名管理界面。 单击“新增域名”，进入“添加域名”页面。 参数配置说明如表1所示 表1 添加域名 参数 说明 域名 输入已备案的域名。 最多可添加5个域名，不支持添加中文域名和泛域名，如“*.example.com”。 建议使用二级以上域名，如“example.yourdomain.com”。 企业项目 若您开通了企业项目管理服务，则需要选择“企业项目”，将新建域名进行分类管理。 服务范围 当前域名的服务范围。 包括如下选项： 中国大陆：仅中国大陆的用户，可以访问当前域名的视频点播内容。 中国大陆境外：仅中国大陆境外的用户，可以访问当前域名的视频点播内容。 全球：全球用户，均可以访问当前域名的视频点播内容。 须知： 如果您选择的服务范围存在跨境场景，您应自行对您的数据跨境行为负责，详见服务声明“2.3 对您的内容数据处理”章节。 单击“确定”，完成添加。 在域名列表中会新增一条“状态”为“配置中”的域名记录。大概3-5分钟时间，当“状态”为“已启用”时，域名添加成功。 域名添加成功后，系统将会为添加的域名分配一个CNAME值。 在域名DNS服务商处配置CNAME解析，并验证CNAME是否生效，具体操作请参见配置CNAME。 若域名添加后未配置CNAME就设置为默认启用，则可能导致点播中的音视频无法正常播放，封面无法正常显示等异常。 在已添加的域名后单击“设为默认”，可以将自有域名设置为默认域名。 每个账户仅能设置一个默认域名，且设置为“默认”的域名必须处于正常启用状态。设置后，您还需要开启该域名的HTTPS安全加速，并上传HTTPS证书，才可以使用该域名向外提供视频点播功能。

URI GET /apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name} 表1 路径参数 参数 是否必选 参数类型 描述 name 是 String name of the PodMetrics namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 pretty 否 String If 'true', then the output is pretty printed.

响应示例 状态码：200 OK { "apiVersion" : "metrics.k8s.io/v1beta1", "containers" : [ { "name" : "container-0", "usage" : { "cpu" : "353450n", "cpu_accumulated" : "127810375798n", "memory" : "1560Ki", "memory_rss" : "284Ki", "memory_usage" : "1824Ki" } } ], "kind" : "PodMetrics", "metadata" : { "creationTimestamp" : "2023-03-28T11:28:23Z", "name" : "cci-deployment-20233231-6c8d7f74f7-2t6k5", "namespace" : "cci-namespace-13238101", "selfLink" : "/apis/metrics.k8s.io/v1beta1/namespaces/cci-namespace-13238101/pods/cci-deployment-20233231-6c8d7f74f7-2t6k5" }, "timestamp" : "2023-03-28T11:28:02Z", "window" : "30s" }

状态码 状态码 描述 200 OK 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 Conflict 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

响应示例 状态码：200 OK { "apiVersion" : "v1", "items" : [ { "data" : { "property_1" : "test" }, "metadata" : { "creationTimestamp" : "2017-12-13T03:15:57Z", "name" : "test-12130306", "namespace" : "ns-12130306-s", "resourceVersion" : "419081", "selfLink" : "/api/v1/namespaces/ns-12130306-s/configmaps/test-12130306", "uid" : "efd6d9e0-dfb3-11e7-9c19-fa163e2d897b" } } ], "kind" : "ConfigMapList", "metadata" : { "resourceVersion" : "419140", "selfLink" : "/api/v1/namespaces/ns-12130306-s/configmaps" } }

URI GET /api/v1/namespaces/{namespace}/configmaps 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 allowWatchBookmarks 否 Boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. continue 否 String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector 否 String A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector 否 String A selector to restrict the list of returned objects by their labels. Defaults to everything. limit 否 Integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. resourceVersion 否 String resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch 否 String resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset timeoutSeconds 否 Integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch 否 Boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. pretty 否 String If 'true', then the output is pretty printed.

状态码 状态码 描述 200 OK 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 Conflict 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

响应示例 状态码：200 OK { "apiVersion" : "v1", "kind" : "APIGroup", "name" : "rbac.authorization.k8s.io", "preferredVersion" : { "groupVersion" : "rbac.authorization.k8s.io/v1", "version" : "v1" }, "versions" : [ { "groupVersion" : "rbac.authorization.k8s.io/v1", "version" : "v1" } ] }

状态码 状态码 描述 200 OK 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 Conflict 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 apiVersion String APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind String Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name String name is the name of the group. preferredVersion io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery object preferredVersion is the version preferred by the API server, which probably is the storage version. serverAddressByClientCIDRs Array of io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR objects a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. versions Array of io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery objects versions are the versions supported in this group. 表3 io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery 参数 参数类型 描述 groupVersion String groupVersion specifies the API group and version in the form "group/version" version String version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. 表4 io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR 参数 参数类型 描述 clientCIDR String The CIDR with which clients can match their IP to figure out the server address that they should use. serverAddress String Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

状态码 状态码 描述 200 OK 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 Conflict 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

响应示例 状态码：200 OK { "apiVersion" : "batch/v1", "items" : [ { "metadata" : { "creationTimestamp" : "2017-12-13T03:15:55Z", "labels" : { "name" : "job-test" }, "name" : "jobs-12130306", "namespace" : "ns-12130306-s", "resourceVersion" : "419064", "selfLink" : "/apis/batch/v1/namespaces/ns-12130306-s/jobs/jobs-12130306", "uid" : "eed6b02b-dfb3-11e7-9c19-fa163e2d897b" }, "spec" : { "completions" : 1, "parallelism" : 1, "selector" : { "matchLabels" : { "controller-uid" : "eed6b02b-dfb3-11e7-9c19-fa163e2d897b" } }, "template" : { "metadata" : { "creationTimestamp" : null, "labels" : { "controller-uid" : "eed6b02b-dfb3-11e7-9c19-fa163e2d897b", "job-name" : "jobs-12130306", "name" : "job-test" }, "name" : "jobs-12130306" }, "spec" : { "containers" : [ { "image" : "172.16.5.235:20202/test/redis:latest", "imagePullPolicy" : "Always", "name" : "jobs-12130306", "resources" : { }, "terminationMessagePath" : "/dev/termination-log", "terminationMessagePolicy" : "File" } ], "dnsPolicy" : "ClusterFirst", "restartPolicy" : "Never", "schedulerName" : "default-scheduler", "securityContext" : { } } } }, "status" : { "active" : 1, "startTime" : "2017-12-13T03:15:55Z" } } ], "kind" : "JobList", "metadata" : { "resourceVersion" : "419065", "selfLink" : "/apis/batch/v1/jobs" } }

URI GET /apis/batch/v1/jobs 表1 Query参数 参数 是否必选 参数类型 描述 allowWatchBookmarks 否 Boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. continue 否 String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector 否 String A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector 否 String A selector to restrict the list of returned objects by their labels. Defaults to everything. limit 否 Integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. pretty 否 String If 'true', then the output is pretty printed. resourceVersion 否 String resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch 否 String resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset timeoutSeconds 否 Integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch 否 Boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

响应示例 状态码：201 Created { "apiVersion" : "crd.yangtse.cni/v1", "kind" : "EIPPool", "metadata" : { "creationTimestamp" : "2023-04-23T06:36:06Z", "generation" : 1, "name" : "eippool-test", "namespace" : "auto-test-namespace", "resourceVersion" : "290279663", "selfLink" : "/apis/crd.yangtse.cni/v1/namespaces/auto-test-namespace/eippools/eippool-test", "uid" : "446b63bb-c1f1-4eb2-8bdf-b77823881d37" }, "spec" : { "amount" : 2, "eipAttributes" : { "bandwidth" : { "chargeMode" : "bandwidth", "name" : "eippool-test", "shareType" : "PER", "size" : 5 }, "ipVersion" : 4, "networkType" : "5_g-vm" } } }

请求示例 动态创建独占带宽类型的EIPPool，资源池中EIP数量为2。 { "apiVersion" : "crd.yangtse.cni/v1", "kind" : "EIPPool", "metadata" : { "name" : "eippool-test" }, "spec" : { "amount" : 2, "eipAttributes" : { "bandwidth" : { "chargeMode" : "bandwidth", "name" : "eippool-test", "shareType" : "PER", "size" : 5 }, "ipVersion" : 4, "networkType" : "5_g-vm" } } }

状态码 状态码 描述 200 OK 201 Created 202 Accepted 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 AlreadyExists 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

URI POST /apis/crd.yangtse.cni/v1/namespaces/{namespace}/eippools 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager 否 String fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. pretty 否 String If 'true', then the output is pretty printed.