云服务器内容精选

  • 背景信息 态势感知 提供基础版、标准版、专业版供您选择。 用户可 免费体验 基础版。 基础版仅提供检测部分威胁风险,呈现一定云上资产安全态势。 为及时和深入了解资产安全状况,确保云上资产安全,建议您升级为标准版或专业版。 标准版提供一定种类的 威胁检测 和分析服务,包括威胁分析、告警设置、主机漏洞、安全日志管理等功能。若需要使用标准版,你需根据全局资产数购买配额,一个资产配额支持全方位防护一台资产。 专业版提供更多种类的威胁检测和分析服务,包含威胁分析、告警设置、主机漏洞、网站漏洞、基线检查、安全日志管理及综合大屏等功能。若需使用专业版服务,您需根据全局资产数购买配额,一个资产配额支持全方位防护一台资产。 更多基础版、标准版、专业版功能差异,请参见服务版本差异。 综合大屏提供“综合态势感知大屏”和“主机安全态势大屏”两种大屏模式,集中展示云上综合安全态势和主机安全状况。综合大屏功能为专业版额外选购付费项目,您可以在购买资产配额后,参考开通综合大屏再购买。 基础版不支持退订。 标准版不支持直接升级到专业版,且专业版也不支持直接变更到标准版。如需使用对应版本,需退订当前版本后再进行购买。 标准版仅支持通过包周期计费模式进行购买。 不支持部分配额购买标准版,部分配额购买专业版。 综合大屏为专业版额外选购付费项目,如需使用综合大屏,请先购买专业版。
  • 响应示例 状态码: 200 请求成功响应参数 { "code" : 0, "message" : "Error message", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "description" : "This my XXXX", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1", "enabled" : true, "status" : "editing", "action_strategy" : "sync", "actions" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "Workflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "string", "playbook_version_id" : "string", "project_id" : "string" } ], "rule_enable" : true, "rules" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "trigger_type" : "event", "dataobject_create" : true, "dataobject_update" : true, "dataobject_delete" : true, "version_type" : 1, "rule_id" : "string", "dataclass_name" : "string", "approve_name" : "string" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 名称
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为:request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String Error message data PlaybookVersionInfo object 剧本版本详情信息 表6 PlaybookVersionInfo 参数 参数类型 描述 id String 剧本版本ID description String 描述 create_time String 创建时间 update_time String 更新时间 project_id String 项目ID creator_id String 创建者ID modifier_id String 修改者ID playbook_id String 剧本ID version String 版本号 enabled Boolean 是否启用。(true--已启用,false-未启用) status String 剧本版本状态,编辑中:EDITING 审核中:APPROVING 不通过:UNPASSED 已发布:PUBLISHED action_strategy String 执行策略. 目前仅支持异步并发执行,对应值为ASYNC actions Array of ActionInfo objects 剧本关联流程列表信息 rule_enable Boolean 是否启用触发条件过滤器 rules RuleInfo object 剧本触发规格信息 dataclass_id String 数据类ID trigger_type String 剧本触发方式(EVENT--事件触发,TIMER--定时触发) dataobject_create Boolean 标识数据对象是否创建时触发剧本 dataobject_update Boolean 标识数据对象是否更新时触发剧本 dataobject_delete Boolean 标识数据对象是否删除时触发剧本 version_type Integer 版本类型(0--草稿版本,1--正式版本) rule_id String 过滤规则ID dataclass_name String 数据类名称 approve_name String 审核者 表7 ActionInfo 参数 参数类型 描述 id String 剧本流程动作ID name String 流程动作名称 description String 描述 action_type String 流程动作类型 action_id String 流程ID playbook_id String 剧本ID playbook_version_id String 剧本版本ID project_id String 项目ID 表8 RuleInfo 参数 参数类型 描述 id String 规则ID project_id String 项目ID rule String 触发规则 状态码: 400 表9 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为:request_uuid-timestamp-hostname 表10 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 version_metadata VersionMetadata object 凭据版本被标记的状态。 表5 VersionMetadata 参数 参数类型 描述 id String 凭据的版本号标识符,凭据对象下唯一。 create_time Long 凭据版本创建时间,时间戳,即从1970年1月1日至该时间的总秒数。 expire_time Long 凭据版本过期时间,时间戳,即从1970年1月1日至该时间的总秒数。默认为空,凭据订阅“版本过期”事件类型时,有效期判断所依据的值。 kms_key_id String 加密版本凭据值的KMS主密钥ID。 secret_name String 凭据名称。 version_stages Array of strings 凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的,如果创建版本时,指定的是同一凭据对象下的一个已经标记在其他版本上的状态,该标签将自动从其他版本上删除,并附加到此版本上。 如果未指定version_stage的值,则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 502 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 504 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 请求已成功 { "version_metadata" : { "id" : "v1", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "SYSCURRENT" ] } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 secret_binary 否 String 新创建凭据的凭据值,将其加密后,存入初始版本中。 类型:base64编码的二进制数据对象。 约束:secret_binary和secret_string必须且只能设置一个,最大32K。 secret_string 否 String 新创建凭据的凭据值,将其加密后,存入初始版本中。 约束:secret_binary和 secret_string必须且只能设置一个,最大32K。 version_stages 否 Array of strings 凭据版本在存入时需要被同时标记的版本状态。如果您不指定此参数,凭据管家默认为新版本标记SYSCURRENT 约束:数组大小:最小1,最大12。stage长度:最小1字节,最大64字节。 expire_time 否 Long 凭据版本过期时间,时间戳,即从1970年1月1日至该时间的总秒数。默认为空,凭据订阅“版本过期”事件类型时,有效期判断所依据的值。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 versions Array of 表3 objects 所有API版本详情列表。 表3 VersionDetails 参数 参数类型 描述 id String 版本ID。 links String 版本详情的URL地址。 version String 该版本API的微版本信息。 status String 版本的状态。 缺省值:CURRENT 枚举值: CURRENT SUPPORTED DEPRECATED updated String 版本更新时间。
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions/{version} Content-Type:application/json X-Auth-Token:******** Instance-Id:******** { "description" : "this is a test app version", "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "Never" }, "image_url" : "example.com/huawei/edge:1.0.0", "volumes" : [ { "name" : "newconfig", "destination" : "newDestination", "source" : "/user" } ] } }
  • 响应示例 状态码: 200 OK { "edge_app_id" : "12617852507412065303014562034843", "version" : "1.0.2", "description" : "hello", "created_time" : "2020-05-28T11:31:29.740Z", "last_modified_time" : "2020-05-28T11:31:29.740Z", "state" : "DRAFT", "command" : null, "args" : null, "container_settings" : null, "publish_time" : null, "off_shelf_time" : "2020-05-28T11:31:29.740Z" }
  • 响应参数 状态码: 200 表11 响应Body参数 参数 参数类型 描述 edge_app_id String 参数说明:用户自定义应用唯一ID。 取值范围:只允许字母、数字、下划线(_)、连接符(-)、美元符号($)的组合。 version String 参数说明:应用版本。 description String 参数说明:应用描述。 取值范围:只允许中文、字母、数字、下划线(_)、中文分号(;)、中文冒号(:)、中文问号(?)、中文感叹号(!)中文逗号(,)、中文句号(。)、英文引号(;)、英文冒号(:)、英文逗号(,)、英文句号(.)、英文问号(?)、英文感叹号(!)、顿号(、)、连接符(-)的组合。 created_time String 参数说明:创建时间。 last_modified_time String 参数说明:最后一次修改时间。 state String 参数说明:应用版本状态。 取值范围: DRAFT:草稿 PUBLISHED:发布 OFF_SHELF:下线 command Array of strings 参数说明:启动命令。 args Array of strings 参数说明:启动参数。 container_settings ContainerSettingsDTO object 参数说明:容器配置。 publish_time String 参数说明:发布时间。 off_shelf_time String 参数说明:下线时间。 表12 ContainerSettingsDTO 参数 参数类型 描述 configs ContainerConfigsDTO object 参数说明:容器特殊参数。 image_url String 参数说明:镜像存储地址。 envs Object 参数说明:环境变量。 volumes Array of VolumeDTO objects 参数说明:卷配置。 resources ResourceDTO object 参数说明:资源配额。 ext_devices Array of ExtDevice objects 参数说明:外挂设备配置。 表13 ContainerConfigsDTO 参数 参数类型 描述 privileged Boolean 参数说明:开启容器特权模式。 host_network Boolean 参数说明:是否使用主机网络模式。 restart_policy String 参数说明:重启策略,容器执行健康检查后失败后的策略。 container_port_list Array of ContainerPortDTO objects 参数说明:容器端口映射值。 表14 ContainerPortDTO 参数 参数类型 描述 container_port Integer 参数说明:构成一对映射的容器端口。 host_port Integer 参数说明:构成一对映射的物理机对应网卡端口。 host_ip String 参数说明:对应网卡地址。 表15 VolumeDTO 参数 参数类型 描述 name String 参数说明:卷名称。 type String 参数说明:挂载类型。 source String 参数说明:源路径。只允许输入数字、大写字母、小写字母、下划线(_)、横杠(-)、斜线(/) destination String 参数说明:卷挂载路径。 read_only Boolean 参数说明:只读,默认只读。 表16 ResourceDTO 参数 参数类型 描述 limits ResourceConfigDTO object 参数说明:允许容器使用的最大资源。 requests ResourceConfigDTO object 参数说明:容器需要使用的最小资源。 表17 ResourceConfigDTO 参数 参数类型 描述 cpu Float 参数说明:cpu个数。 memory Float 参数说明:内存大小。 gpu Float 参数说明:gpu个数。 npu Float 参数说明:npu个数。 表18 ExtDevice 参数 参数类型 描述 source String 参数说明:源路径。 destination String 参数说明:卷挂载路径。 cgroup_permissions String 参数说明:只读,默认MRW。
  • 示例代码 查询数据集版本列表 from modelarts.session import Session from modelarts.dataset import Dataset session = Session() dataset = Dataset(session, dataset_id) version_list = dataset.list_versions() print(version_list) # 打印数据集的版本列表
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_versions" : [ { "app_id" : "string", "version" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 app_versions Array of QueryAppVersionResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppVersionResponseDTO 参数 参数类型 描述 app_id String 应用模板ID version String 应用版本 values Object 应用版本配置 create_time String 创建时间 update_time String 最后一次修改时间
  • URI GET /v3/{project_id}/apps/{app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 应用版本号 最小长度:1 最大长度:32 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0。 最小值:0 最大值:1000000 缺省值:0