API Explorer

名称	类型	IN	必选	描述
X-Language	string	header	否	语言。中文:zh_CN英文:en_US缺省为zh_CN。
X-Auth-Token	string	header	是	合作伙伴Token调用

名称

类型

必选

描述

X-Language

string

header

否

语言。中文:zh_CN英文:en_US缺省为zh_CN。

X-Auth-Token

string

header

是

合作伙伴Token调用

名称	类型	必选	描述
customer_id	string	是	客户账号ID。您可以调用查询客户列表接口获取customer_id。
region_code	string	否	云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。
service_type_code	string	否	云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。
resource_ids	Array of strings	否	资源ID批量查询。用于查询指定资源ID对应的资源。最多支持同时传递50个ID的列表。此参数不携带或携带值为空列表或携带值为null时,不作为筛选条件。
effective_time_begin	string	否	生效时间的开始时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。
effective_time_end	string	否	生效时间的结束时间 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。
offset	integer	否	偏移量,从0开始。默认值为0。说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。
limit	integer	否	一次查询的条数,默认值为10。
status	integer	否	资源状态: 1:正常(已开通)2:宽限期3:冻结中4:变更中5:正在关闭6:已关闭此参数不携带或携带值为null时,不作为筛选条件。
indirect_partner_id	string	否	云经销商ID。获取方法请参见查询云经销商列表。如果需要查询云经销商子客户的按需资源列表,必须携带该字段,除此之外,此参数不做处理。否则只能查询自己的子客户按需资源。

名称	类型	描述
resources	Array of CustomerOnDemandResource objects	客户资源列表。具体参见表2。
total_count	integer	查询总数。

名称

类型

描述

resources

Array of CustomerOnDemandResource objects

客户资源列表。具体参见表2。

total_count

integer

查询总数。

名称	类型	描述
customer_id	string	客户账号ID。
region_code	string	云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。
availability_zone_code	string	所属可用区的编码。
service_type_code	string	云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。
resource_type_code	string	资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。
service_type_name	string	云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。
resource_type_name	string	资源类型名称。例如ECS的资源类型名称为“云主机”。
resource_id	string	资源ID。
resource_name	string	资源实例名称。
effective_time	string	生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。
expire_time	string	失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。
status	integer	资源状态: 1:正常(已开通)2:宽限期3:冻结中4:变更中5:正在关闭6:已关闭
resource_spec_code	string	云服务产品的资源规格。如果是VM的资源规格,则需要在规格后面添加“.win”或“.linux”,例如“s2.small.1.linux”。
resource_info	string	按需资源的容量大小。格式如:"resourceInfo": "{\"specSize\":40.0}"
product_spec_desc	string	产品规格描述。例如: 虚拟机:“通用计算增强型\|c6.2xlarge.4\|8vCPUs\|32GB\|linux”硬盘:“云硬盘_SATA_LXH01\|40.0GB”

名称

类型

描述

customer_id

string

客户账号ID。

region_code

string

云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

availability_zone_code

string

所属可用区的编码。

service_type_code

string

云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。

resource_type_code

string

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

service_type_name

string

云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。

resource_type_name

string

资源类型名称。例如ECS的资源类型名称为“云主机”。

resource_id

string

资源ID。

resource_name

string

资源实例名称。

effective_time

string

生效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。

expire_time

string

失效时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。其中,HH范围是0~23,mm和ss范围是0~59。

status

integer

资源状态: 1:正常(已开通)2:宽限期3:冻结中4:变更中5:正在关闭6:已关闭

resource_spec_code

string

云服务产品的资源规格。如果是VM的资源规格,则需要在规格后面添加“.win”或“.linux”,例如“s2.small.1.linux”。

resource_info

string

按需资源的容量大小。格式如:"resourceInfo": "{\"specSize\":40.0}"

product_spec_desc

string

{ "indirect_partner_id": "051a8a834180d3fb0f25c006b1998800", "offset": 0, "limit": 10, "effective_time_begin": "2020-04-02T08:56:26Z", "effective_time_end": "2020-05-02T08:56:26Z", "customer_id": "0846606cf580d45f0fd6c01e10c07540", "service_type_code": "hws.service.type.ebs", "resource_ids": [ "batch-volume-16380-00024604" ], "region_code": "cn-east-2", "status": 1 }

{ "resources": [ { "customer_id": "0846606cf580d45f0fd6c01e10c07540", "region_code": "cn-east-2", "availability_zone_code": "cn-east-2-a", "service_type_code": "hws.service.type.ebs", "resource_type_code": "hws.resource.type.volume", "resource_id": "batch-volume-16380-00024604", "resource_name": "batch-volume", "effective_time": "2020-04-02T08:56:26Z", "expire_time": "2020-05-02T08:56:26Z", "status": 1, "resource_spec_code": "SATA", "resource_info": "{\"specSize\":2235.0}", "product_spec_desc": "High IO|40.0GB" } ], "total_count": 1 }

本文导读