云服务器内容精选

  • 请求 请求header参数 请参见请求示例中header描述。 请求body参数 无 请求示例 GET /rest/mogaiaservice/v1.0/visuals?type=xxx&name=xxx&start=xxx&limit=xxx&category=xxx&managed_status=xxx&project_id=xxx&sort_key=xxx&sort_order=xxx&is_preset=xxx&created_user_name=xxx&catalog_id=xxx HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json
  • 响应 响应参数 响应状态码200:返回VisualsListResponse。 表3 VisualsListResponse对象属性 参数 是否必选 类型 值域 说明 Visuals 否 表4 无 项目列表 total 否 integer 无 项目总数 表4 VisualsInfo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 可视化ID name 否 string 无 名称 description 否 string 无 描述 owner 否 string 无 数据Owner category 否 string 无 归属类别, report-报表, screen-大屏 security_level 否 string 无 密级: open-公开 secret-秘密 top-机密 managed_status 否 integer 无 状态 0-创建,1-删除,2-发布 from_project_id 否 string 无 归属的OCC项目ID from_project_name 否 string 无 归属的OCC项目名称 template_id 否 string 无 模板ID snapshot_id 否 string 无 快照ID thumbnail 否 string 无 缩略图的地址 created_date 否 int64 无 创建时间 created_by 否 string 无 创建者 created_user_name 否 string 无 创建者名字 last_updated_date 否 int64 无 最近更新时间 last_updated_by 否 string 无 最近更新者 iam_project_id 否 string 无 IAM 中project ID domain_id 否 string 无 domain share 否 string 无 分析ID workspace_id 否 string 无 工作空间ID nav_catalog_id 否 string 无 分类ID nav_catalog_name 否 string 无 分类名称 nav_catalog_name_en 否 string 无 分类英文名称 subscribed_sum 否 int32 默认值:0 已订阅数量 x_language 否 string 无 国际化字段 is_preset 否 int32 默认值:0 是否预置数据 conflict_name 否 string 无 冲突名字 parent_id 否 string 无 父id format 否 integer 无 格式:1-文档,2-幻灯片 scope 否 integer 无 使用域:1-通用,2-专用 manager 否 string 无 管理者(该参数用于存用户id,以“,”方式分隔) published_date 否 int64 无 发布时间 dv_token 否 string 无 dv_token dv_password 否 string 无 dv_password dv_expiration_date 否 string 无 dv_expiration_date dv_is_auth 否 string 无 dv_is_auth dv_type 否 string 无 dv_type dv_snap_shot_id 否 string 无 dv_snap_shot_id dv_current_time 否 int64 无 dv_current_time 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8
  • URI /rest/mogaiaservice/v1.0/visuals_for_sre 路径参数 无 查询参数 表2 查询参数 参数 是否必选 类型 值域 说明 type 否 string list card 呈现方式。 list-列表,card-卡片 name 否 string 无 名称 start 否 string 无 起始页 limit 否 string 0~1000 分页,有效值0~1000 category 否 string report screen 类型,报表-report,大屏-screen managed_status 否 string 0 2 类型,0-创建,2-发布 project_id 否 string 无 归属项目 sort_key 否 string created_date name last_updated_date 排序字段名称,支持的合法取值:created_date, name, last_updated_date sort_order 否 string asc desc 排序顺序,支持的取值:asc(升序)、desc(降序),默认:desc。 is_preset 否 string 0 1 是否预置,预置-1,非预置-0 created_user_name 否 string 无 创建人 catalog_id 否 string 无 所属类型id
  • 基本概念 账号 用户的账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中的资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间的资源进行分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。
  • 请求 请求header参数 请参见请求示例中header描述。 请求body参数 表1 CreateQueryJobRequest对象属性 参数 是否必选 类型 值域 说明 hcso_id 否 string 正则表达式为^[-_0-9a-zA-Z]{0,36} hcso id region_id 否 string 正则表达式为^[-_0-9a-zA-Z]{0,255} hcso id min_sdr_time 否 string 正则表达式为^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 话单文件最小值:2022-01-01 00:00:00,(只使用年月日部分,即查询2022年1月1日开始的话单) max_sdr_time 否 string 正则表达式为^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ 话单文件最大值:2022-01-31 00:00:00,(只使用年月日部分,即查询2022年1月30日结束的话单) 请求示例 POST /meter/v1/{domain_id}/query-jobs HTTP/1.1Host: example.comContent-Type: application/jsonAccept: application/jsonX-Auth-Token: xxx{ "hcso_id": "xxx", "region_id": "region", "min_sdr_time": "2022-01-01 00:00:00", "max_sdr_time": "2022-02-01 00:00:00" }
  • 响应 响应参数 响应状态码201:返回CreateQueryJobResponse。 表2 CreateQueryJobResponse对象属性 参数 是否必选 类型 值域 说明 job_id 否 string 无 任务id。 响应示例 HTTP/1.1 201 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8{ "job_id": "xxx" }
  • 请求 请求header参数 表3 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 无 用户Token。 X-Language 否 string zh-cn en-us 语言信息。 请求body参数 无 请求示例 DELETE /rest/gaia/v1/homs/hcso/delete/{domainId} HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json
  • 响应 响应参数 响应状态码200:返回CommonResult。 表4 CommonResult对象属性 参数 是否必选 类型 值域 说明 status 否 string SUC CES S FAIL 默认值:SUCCESS 成功与否 fail_reason 否 string 无 错误原因 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8
  • 请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。H CS O场景必填,其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/TanentCloudResource/InstanceData/EVS HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid:xxx x-hcso-appcode:xxx
  • 请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填,其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/TanentCloudResource/InstanceData/ECS HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid:xxx x-hcso-appcode:xxx
  • 响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名,标识资源所属的云服务。BMS裸金属服务。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region 中文名。 zone_type 否 String 无 资源所属区域类型:MANAGE管理区,POD或KVM_POD租户区。 allocated 是 String 无 已分配量,xx台(单位)。 available 是 String 无 剩余量,xx台(单位)。 total(list内) 是 String 无 裸金属服务器可用总量,xx台(单位)。 metric_type 否 String 无 裸金属服务器规格型号指标:如physical.kd1ne.2xlarge型号。 响应示例 HTTP/1.1 200 OK Date:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "service_type": "BMS", "total": "4", "available": "4", "metric_type": "physical.kd1ne.2xlarge", "zone_type": "POD", "used": "0", "free": "0", "used_ratio": "0", "region": "cn-east-264", "resource_count": "0", "allocated": "0", "timestamp": "1650211200000" } ] }
  • 请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是(HCSO场景) 否(其他场景) string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间(毫秒时间戳)。 end_time 是 int 无 查询结束时间(毫秒时间戳)。 service_type 否 string BMS 服务类型。 zone_type 否 string BMS_POD BMS专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=BMS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid:xxx x-hcso-appcode:xxx
  • 响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名,标识资源所属的云服务RDS云数据库服务。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属区域类型:RDS_POD租户区使用。 total(list内) 否 String 无 可用总量,xx台(单位:实例数)。 allocated 是 String 无 已分配发放量,xx台(单位:实例数)。 avaliable 是 String 无 剩余可发放量,xx台(单位:实例数)。 metric_type 否 String 无 RDS服务指标类型;如:后端为SQLServer关系型DB实例,NoSQLServer非关系DB实例。 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total":33, "list":[ { "service_type":"RDS", "metric_type":"dbtype:sqlServer/nosqlServer", "total":"总数量,单位台", "used":"已使用量", "free":"剩余量", "allocated":"可分配量", "available":"可用量", "used_ratio":"null", "allocated_ratio":"null", "resource_count":"null", "zone_type":"RDS_POD", "timestamp":"时间戳", "region":"cn-north-1" } ] }
  • 请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是(HCSO场景) 否(其他场景) string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间(毫秒时间戳)。 end_time 是 int 无 查询结束时间(毫秒时间戳)。 service_type 否 string RDS 服务类型。 zone_type 否 string RDS_POD RDS专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=RDS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid:xxx x-hcso-appcode:xxx
  • 请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是(HCSO场景) 否(其他场景) string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间(毫秒时间戳)。 end_time 是 int 无 查询结束时间(毫秒时间戳)。 service_type 否 string EVS 服务类型。 zone_type 否 string manage/pod manage管理区,pod租户区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=EVS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid:xxx x-hcso-appcode:xxx