Querying Deployed Resources
Function
Query the resources deployed for the issued and uploaded non-SM series cryptographic algorithm certificates.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
scm:cert:listDeployedResources
List
cert *
g:ResourceTag/<tag-key>
- scm:cert:deployed
-
-
g:EnterpriseProjectId
URI
POST /v3/scm/deployed-resources
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
certificate_ids |
Yes |
Array of strings |
Certificate ID list. Minimum: 16 Maximum: 16 Array Length: 1 - 50 |
|
service_names |
Yes |
Array of strings |
Service name list. Minimum: 0 Maximum: 5 Array Length: 1 - 50 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
results |
Array of ResultDetail objects |
Request result list. For details, see data structure of the ResultDetail field. Array Length: 1 - 50 |
|
Parameter |
Type |
Description |
|---|---|---|
|
certificate_id |
String |
Certificate ID. Minimum: 16 Maximum: 16 |
|
total_num |
Integer |
Number of resources deployed for the certificate in the current service. Minimum: 0 Maximum: 1000 |
|
deployed_resources |
Array of DeployedResourceDetail objects |
List of resources deployed under the current certificate. For details, see data structure of the DeployedResourceDetail field. Array Length: 0 - 100 |
|
Parameter |
Type |
Description |
|---|---|---|
|
service |
String |
Name of the resource service where the certificate has been deployed.
Minimum: 0 Maximum: 5 |
|
resource_num |
Integer |
Number of resources deployed for the certificate in the current service. Minimum: 0 Maximum: 1000 |
|
resource_location |
String |
Global service or region-level service. Minimum: 0 Maximum: 63 |
|
region_resources |
Array of RegionResourceDetail objects |
Region resource list. For details, see data structure description of the RegionResourceDetail field. Array Length: 0 - 100 |
|
Parameter |
Type |
Description |
|---|---|---|
|
region_id |
String |
Region ID. If the service is a global service, set region_id to global. Other services are named based on the IAM. Minimum: 0 Maximum: 63 |
|
is_error |
Boolean |
Indicates whether an exception occurs in the response when the resource information of the current region is requested. |
|
resources |
Array of ResourceDetail objects |
Resource set. The identifier of each resource is in the format of resource ID + : + resource name. For details, see the data structure description of the ResourceDetail field. Array Length: 0 - 100 |
|
Parameter |
Type |
Description |
|---|---|---|
|
resource_id |
String |
Resource ID. Minimum: 0 Maximum: 63 |
|
resource_name |
String |
Resource name. Options: Minimum: 0 Maximum: 63 |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Example Requests
{
"certificate_ids" : [ "scs1665472591541" ],
"service_names" : [ "WAF" ]
}
Example Responses
Status code: 200
Normal response.
{
"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"
} ]
} ]
} ]
} ]
}
Status code: 401
Authentication failed.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
Status code: 403
Access denied.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
Status code: 500
Failed to complete the request because of an internal server error.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
SDK Sample Code
The SDK sample code is as follows.
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) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Normal response. |
|
401 |
Authentication failed. |
|
403 |
Access denied. |
|
404 |
Access page not found. |
|
500 |
Failed to complete the request because of an internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot