文档首页/ 云证书管理服务 CCM/ API参考/ API/ 管理SSL证书/ 证书部署管理/ 查询已部署资源
更新时间：2024-12-18 GMT+08:00
查看PDF
分享

查询已部署资源

功能介绍

查询证书已部署的具体资源。针对已签发和上传的非国密证书

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/scm/deployed-resources

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：32

最大长度：2097152
表2 请求Body参数

参数

是否必选

参数类型

描述

certificate_ids

是

Array of strings

证书ID列表。

最小长度：16

最大长度：16

数组长度：1 - 50

service_names

是

Array of strings

服务名称列表。

  • WAF：查询证书关联Web应用防火墙的资源。

  • CDN：查询证书关联内容分发网络的资源。

  • ELB：查询证书关联弹性负载均衡（经典型）的资源。

  • OBS：查询证书关联对象存储服务的资源。

  • ALL：查询证书以上四种服务的资源。

最小长度：0

最大长度：5

数组长度：1 - 50

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

results

Array of ResultDetail objects

请求结果列表，详情请参见ResultDetail字段数据结构说明。

数组长度：1 - 50
表4 ResultDetail

参数

参数类型

描述

certificate_id

String

证书ID。

最小长度：16

最大长度：16

total_num

Integer

当前证书在所查询服务中已部署资源总数。

最小值：0

最大值：1000

deployed_resources

Array of DeployedResourceDetail objects

当前证书已部署资源列表，详情请参见DeployedResourceDetail字段数据结构说明。

数组长度：0 - 100
表5 DeployedResourceDetail

参数

参数类型

描述

service

String

证书已部署资源服务名称。

  • WAF：证书关联Web应用防火墙的资源。

  • CDN：证书关联内容分发网络的资源。

  • ELB：证书关联弹性负载均衡（经典型）的资源。

最小长度：0

最大长度：5

resource_num

Integer

证书在当前服务已部署资源数量。

最小值：0

最大值：1000

resource_location

String

全局服务或Region级服务。

最小长度：0

最大长度：63

region_resources

Array of RegionResourceDetail objects

局点资源列表，详情请参见RegionResourceDetail字段数据结构说明。

数组长度：0 - 100
表6 RegionResourceDetail

参数

参数类型

描述

region_id

String

局点ID。当服务为全局服务时，region_id为global，其余按照IAM的标准命名。

最小长度：0

最大长度：63

is_error

Boolean

请求当前region资源信息过程中，响应是否存在异常的标志。

  • true : 存在异常，当前region所统计数据不准确

  • false: 无异常，当前region所统计数据准确

resources

Array of ResourceDetail objects

资源集合，每个资源的标识：资源ID + “:” + 资源名称，详情请参见ResourceDetail字段数据结构说明。

数组长度：0 - 100
表7 ResourceDetail

参数

参数类型

描述

resource_id

String

资源ID。

最小长度：0

最大长度：63

resource_name

String

资源名称。

最小长度：0

最大长度：63

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

请求示例

{
  "certificate_ids" : [ "scs1665472591541" ],
  "service_names" : [ "WAF" ]
}

响应示例

状态码： 200

正常返回。

{
  "results" : [ {
    "certificate_id" : "scs1665472591541",
    "total_num" : 1,
    "deployed_resources" : [ {
      "service" : "ELB",
      "resource_num" : 1,
      "resource_location" : "region",
      "region_resources" : [ {
        "region_id" : "cn-north-7",
        "is_error" : false,
        "resources" : [ {
          "resource_id" : "d93c9fe40959468eb2baf32590a1140a",
          "resource_name" : "xxxx"
        } ]
      } ]
    } ]
  } ]
}

状态码： 401

认证失败。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码： 403

禁止访问。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码： 500

请求未完成，服务器内部异常。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

200

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

请求未完成，服务器内部异常。

错误码

请参见错误码。

父主题： 证书部署管理

相关文档