Listing Cloud Services
Function
Querying cloud services, resources, and regions
Calling Method
For details, see Calling APIs.
URI
GET /v1/resource-manager/domains/{domain_id}/providers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Specifies the pagination offset. Minimum: 1 Maximum: 1000 |
limit |
No |
Integer |
Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200 |
track |
No |
String |
Specifies whether resources are collected by default. tracked indicates that resources are collected by default, and untracked indicates that resources are not collected by default. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Language |
No |
String |
Specifies the language of the information to return. The default name is zh-cn, which can be zh-cn and en-us. Default: zh-cn |
X-Auth-Token |
No |
String |
Specifies the invoker's token. |
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resource_providers |
Array of ResourceProviderResponse objects |
Specifies the list of cloud service details. |
total_count |
Integer |
Specifies the total number of cloud services. |
Parameter |
Type |
Description |
---|---|---|
provider |
String |
Specifies the cloud service name. |
display_name |
String |
Specifies the display name of the cloud service. You can set the language by configuring X-Language in the request header. |
category_display_name |
String |
Specifies the display name of the cloud service type. You can set the language by configuring X-Language in the request header. |
resource_types |
Array of ResourceTypeResponse objects |
Specifies the resource type list. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Specifies the resource type. |
display_name |
String |
Specifies the display name of the resource type. You can set the language by configuring X-Language in the request header. |
global |
Boolean |
Specifies whether the resource is a global resource. |
regions |
Array of strings |
Specifies the list of supported regions. |
console_endpoint_id |
String |
Specifies the console endpoint ID. |
console_list_url |
String |
Specifies the URL of the resource list page on the console. |
console_detail_url |
String |
Specifies the URL of the resource details page on the console. |
track |
String |
Specifies whether resources are collected by default. tracked indicates that resources are collected by default, and untracked indicates that resources are not collected by default. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
None
Example Responses
Status code: 200
Operation succeeded.
{ "total_count" : 2, "resource_providers" : [ { "provider" : "ecs", "display_name" : "ECS", "category_display_name" : "Compute", "resource_types" : [ { "name" : "cloudservers", "display_name" : "Cloud servers", "global" : false, "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ], "console_endpoint_id" : "ecm", "console_list_url" : "#/ecs/manager/vmList", "console_detail_url" : "#/ecs/manager/ecsDetail?instanceId={id}", "track" : "tracked" } ] }, { "provider" : "vpc", "display_name" : "VPC", "category_display_name" : "Networking", "resource_types" : [ { "name" : "vpcs", "display_name" : "VPC", "global" : false, "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ], "console_endpoint_id" : "vpc", "console_list_url" : "#/vpcs", "console_detail_url" : "#/vpc/vpcmanager/vpcDetail/subnets?vpcId={id}", "track" : "tracked" }, { "name" : "bandwidths", "display_name" : "Shared bandwidth", "global" : false, "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ], "console_endpoint_id" : "vpc", "console_list_url" : "#/vpc/vpcmanager/shareBandwidth", "console_detail_url" : "#/vpc/vpcmanager/shareBandwidth?bandwidthId={id}", "track" : "tracked" }, { "name" : "securityGroups", "display_name" : "Security groups", "global" : false, "regions" : [ "regionid1", "regionid2", "regionid5", "regionid6" ], "console_endpoint_id" : "vpc", "console_list_url" : "#/secGroups", "console_detail_url" : "#/vpc/vpcmanager/sgDetail/sgRules?instanceId={id}", "track" : "tracked" }, { "name" : "publicips", "display_name" : "EIPs", "global" : false, "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid6" ], "console_endpoint_id" : "vpc", "console_list_url" : "#/vpc/vpcmanager/eips", "console_detail_url" : "#/vpc/vpcmanager/eipDetailNew?eipId={id}", "track" : "tracked" } ] } ] }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class ListProvidersSolution { 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); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); ListProvidersRequest request = new ListProvidersRequest(); request.withTrack(ListProvidersRequest.TrackEnum.fromValue("<track>")); request.withOffset(<offset>); request.withLimit(<limit>); try { ListProvidersResponse response = client.listProviders(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 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 = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListProvidersRequest() request.track = "<track>" request.offset = <offset> request.limit = <limit> response = client.list_providers(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/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 := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListProvidersRequest{} trackRequest:= model.GetListProvidersRequestTrackEnum().<TRACK> request.Track = &trackRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest response, err := client.ListProviders(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Operation succeeded. |
500 |
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