文档首页/ 云证书与管理服务 CCM/ API参考/ API/ 管理SSL证书/ 证书部署管理/ 查询已部署资源 - ListDeployedResources
更新时间:2025-11-28 GMT+08:00
分享

查询已部署资源 - ListDeployedResources

功能介绍

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

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    scm:cert:listDeployedResources

    List

    cert *

    g:ResourceTag/<tag-key>

    • scm:cert:deployed

    -

    -

    g:EnterpriseProjectId

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:查询证书关联弹性负载均衡(经典型)的资源。

  • 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"
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.scm.v3.region.ScmRegion;
import com.huaweicloud.sdk.scm.v3.*;
import com.huaweicloud.sdk.scm.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListDeployedResourcesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ScmClient client = ScmClient.newBuilder()
                .withCredential(auth)
                .withRegion(ScmRegion.valueOf("<YOUR REGION>"))
                .build();
        ListDeployedResourcesRequest request = new ListDeployedResourcesRequest();
        ListDeployedResourcesRequestBody body = new ListDeployedResourcesRequestBody();
        List<String> listbodyServiceNames = new ArrayList<>();
        listbodyServiceNames.add("WAF");
        List<String> listbodyCertificateIds = new ArrayList<>();
        listbodyCertificateIds.add("scs1665472591541");
        body.withServiceNames(listbodyServiceNames);
        body.withCertificateIds(listbodyCertificateIds);
        request.withBody(body);
        try {
            ListDeployedResourcesResponse response = client.listDeployedResources(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkscm.v3.region.scm_region import ScmRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkscm.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = ScmClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ScmRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListDeployedResourcesRequest()
        listServiceNamesbody = [
            "WAF"
        ]
        listCertificateIdsbody = [
            "scs1665472591541"
        ]
        request.body = ListDeployedResourcesRequestBody(
            service_names=listServiceNamesbody,
            certificate_ids=listCertificateIdsbody
        )
        response = client.list_deployed_resources(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    scm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := scm.NewScmClient(
        scm.ScmClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListDeployedResourcesRequest{}
	var listServiceNamesbody = []string{
        "WAF",
    }
	var listCertificateIdsbody = []string{
        "scs1665472591541",
    }
	request.Body = &model.ListDeployedResourcesRequestBody{
		ServiceNames: listServiceNamesbody,
		CertificateIds: listCertificateIdsbody,
	}
	response, err := client.ListDeployedResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

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

错误码

请参见错误码

相关文档