云服务器内容精选

  • 请求示例 查询防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf的标签信息 https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/tags?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4
  • URI GET /v2/{project_id}/cfw-cfw/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 分页查询数据限制 offset 是 Integer 查询偏移量 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,可通过如何获取用户Token获取 表4 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of CreateTag objects 创建防火墙标签列表 表5 CreateTag 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值
  • URI PUT /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/save 表1 路径参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙ID,可通过防火墙ID获取方式获取 project_id 是 String 项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0
  • 请求示例 保存项目id为eefb11b22d5944f2aa067954516df1cf的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。 https://{Endpoint}/v2/eefb11b22d5944f2aa067954516df1cf/cfw-cfw/e743cfaf-8164-4807-aa13-d893d83313cf/tags/save?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4 { "tags" : [ { "key" : "test", "value" : "1" }, { "key" : "tag_zjw-1", "value" : "1" } ] }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 action 是 String 操作标识(区分大小写):创建时为“create”。 tags 是 Array of objects 标签列表。单个实例总标签数上限20个。 详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 标签键。长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 value 是 String 标签值。最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。
  • 请求示例 批量添加标签key1和key2。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action { "action": "create", "tags": [{ "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }] }
  • 响应示例 状态码: 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常" } 示例 2 { "error_code" : "GSL.00022001", "error_msg" : "标签名称不合法,请检查!" } 示例 3 { "error_code" : "GSL.00022002", "error_msg" : "标签名称已存在,请重新输入!" } 示例 4 { "error_code" : "GSL.00022003", "error_msg" : "登录用户最多可以创建10000个标签。" } 示例 5 { "error_code" : "GSL.00022004", "error_msg" : "登录用户没有标签的访问权限。" } 状态码: 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙,请稍后重试。" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 id Long 标签标识 tag_name String 标签名称 最大长度:100 status Integer 标签状态,0未使用,1使用中。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token。 最小长度:1 最大长度:16384
  • URI GET /v2/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ resource_type 是 String 资源类型。 CES -alarm:告警规则,CES-dashboard:dashboard,CES-resourceGroup:资源分组,CES-qualityMonitor:质量监控 最小长度:1 最大长度:32 枚举值: CES-alarm CES-dashboard CES-resourceGroup CES-qualityMonitor
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 租户标签列表 数组长度:0 - 20 表4 Tag 参数 参数类型 描述 key String 键;最大长度128个unicode字符。 key不能为空。 最小长度:0 最大长度:128 values Array of strings 值列表; 每个值最大长度255个unicode字符。如果values为空列表,则表示查询任意value 最小长度:0 最大长度:255 数组长度:0 - 20 状态码: 404 表5 响应Body参数 参数 参数类型 描述 http_code Integer Http状态码。200::OK,404:资源不存在。 最小值:3 最大值:3 枚举值: 200 404 message GoAPIErrorResponseMsg object 错误信息 表6 GoAPIErrorResponseMsg 参数 参数类型 描述 details String 错误信息 最小长度:0 最大长度:1024 code String 业务错误码 最小长度:1 最大长度:16
  • 响应示例 状态码: 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "806064a8-7478-4657-a8b0-2edc90621235" }, { "resource_name" : "test" }, { "resource_detail" : [ { "ca_id" : "806064a8-7478-4657-a8b0-2edc90621235", "create_time" : 1681436805000, "delete_time" : null, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null }, "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "TestA IT Root CA" }, "enc_cert_info" : null, "enterprise_project_id" : "57d71362-6a1a-4f51-8fa9-693bc3c07f43", "freeze_flag" : 0, "gen_mode" : "GENERATE", "issuer_id" : null, "issuer_name" : null, "key_algorithm" : "SM2", "not_before" : 1681436805000, "not_after" : 1713059205000, "path_length" : 7, "serial_number" : "202203070322544291829058", "signature_algorithm" : "SM3", "status" : "ACTIVED", "type" : "ROOT" } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] } ] } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 请求示例 根据标签查询CA列表,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificate-authorities/resource-instances/filter { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值:0 最大值:100 resources Array of TagResource objects 资源实例列表,详情请参见TagResource字段数据结构说明。 数组长度:0 - 100 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度:0 最大长度:63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表,没有标签默认为空数组。 数组长度:0 - 100 resource_name String 资源名称,默认为空字符串。 最小长度:0 最大长度:63 表7 ResourceTag 参数 参数类型 描述 key String 标签键。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value String 标签值。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024