列举云服务
功能介绍
查询支持的云服务、资源和区域列表。
调用方法
请参见如何调用API。
URI
GET /v1/resource-manager/domains/{domain_id}/providers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
分页偏移。 最小值:1 最大值:1000 |
limit |
否 |
Integer |
最大的返回数量。 最小值:1 最大值:200 缺省值:200 |
track |
否 |
String |
资源是否默认收集,"tracked"表示默认收集,"untracked"表示默认不收集。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Language |
否 |
String |
选择接口返回的信息的语言,默认为"zh-cn"中文,可选值:zh-cn和en-us。 缺省值:zh-cn |
X-Auth-Token |
否 |
String |
调用者token。 |
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resource_providers |
Array of ResourceProviderResponse objects |
云服务详情列表。 |
total_count |
Integer |
当前支持的云服务总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
provider |
String |
云服务名称。 |
display_name |
String |
云服务显示名称,可以通过请求Header中的'X-Language'设置语言。 |
category_display_name |
String |
云服务类别显示名称,可以通过请求Header中的'X-Language'设置语言。 |
resource_types |
Array of ResourceTypeResponse objects |
资源类型列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
资源类型名称。 |
display_name |
String |
资源类型显示名称,可以通过请求中 'X-Language'设置语言。 |
global |
Boolean |
是否是全局类型的资源。 |
regions |
Array of strings |
支持的region列表。 |
console_endpoint_id |
String |
console终端ID。 |
console_list_url |
String |
console列表页地址。 |
console_detail_url |
String |
console详情页地址。 |
track |
String |
资源是否默认搜集,"tracked"表示默认收集,"untracked"表示默认不收集。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
请求示例
无
响应示例
状态码: 200
操作成功。
{ "total_count" : 2, "resource_providers" : [ { "provider" : "ecs", "display_name" : "弹性云服务器 ECS", "category_display_name" : "计算", "resource_types" : [ { "name" : "cloudservers", "display_name" : "云服务器", "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" : "网络", "resource_types" : [ { "name" : "vpcs", "display_name" : "虚拟私有云", "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" : "共享带宽", "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" : "安全组", "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" : "弹性公网IP", "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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
500 |
服务器内部错误。 |
错误码
请参见错误码。