Skip to content

Commit a76828a

Browse files
author
v_suiyufei
committed
aihc-dev-12825 [Task] 【python sdk】修正拉取服务列表接口参数
Change-Id: Id85bf4e9b4080b20f1d400db6a55491c6041cd25
1 parent 80beebd commit a76828a

2 files changed

Lines changed: 35 additions & 25 deletions

File tree

baidubce/services/aihc/modules/service/service_client.py

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,41 +23,41 @@
2323
class ServiceClient(AIHCBaseClient):
2424
"""在线服务相关接口客户端"""
2525

26-
def DescribeServices(self, resourcePoolId=None, queueName=None, name=None, region=None, pageNumber=1, pageSize=10):
26+
def DescribeServices(
27+
self,
28+
pageNumber: Optional[int] = None,
29+
pageSize: Optional[int] = None,
30+
orderBy: Optional[str] = None,
31+
order: Optional[str] = None
32+
):
2733
"""
2834
拉取服务列表。
2935
3036
参考文档:https://cloud.baidu.com/doc/AIHC/s/Imb4v5905
3137
32-
:param resourcePoolId: 资源池ID(可选,Query参数)
33-
:type resourcePoolId: str
34-
:param queueName: 队列名称(可选,Query参数)
35-
:type queueName: str
36-
:param name: 服务名称(可选,Query参数)
37-
:type name: str
38-
:param region: 区域(可选,Query参数)
39-
:type region: str
40-
:param pageNumber: 页码,默认1(可选,Query参数)
41-
:type pageNumber: int
42-
:param pageSize: 每页数量,默认10(可选,Query参数)
43-
:type pageSize: int
44-
:return: 服务列表及总数
45-
:rtype: baidubce.bce_response.BceResponse
38+
Args:
39+
pageNumber: 页码,从1开始(可选,Query参数)
40+
pageSize: 分页大小,默认为10(可选,Query参数)
41+
orderBy: 排序字段,暂时只支持创建时间createdAt(可选,Query参数)
42+
order: 排序方式,asc或desc,默认desc(可选,Query参数)
43+
44+
Returns:
45+
baidubce.bce_response.BceResponse: 服务列表及总数
46+
47+
Raises:
48+
BceHttpClientError: 当API调用失败时抛出
49+
BceServerError: 当服务器返回错误时抛出
4650
"""
4751
path = b'/'
4852
params = {
4953
'action': 'DescribeServices',
5054
'pageNumber': pageNumber,
5155
'pageSize': pageSize,
5256
}
53-
if resourcePoolId is not None:
54-
params['resourcePoolId'] = resourcePoolId
55-
if queueName is not None:
56-
params['queueName'] = queueName
57-
if name is not None:
58-
params['name'] = name
59-
if region is not None:
60-
params['region'] = region
57+
if orderBy is not None:
58+
params['orderBy'] = orderBy
59+
if order is not None:
60+
params['order'] = order
6161
return self._send_request(
6262
http_methods.GET,
6363
path,

sample/aihc/aihc_service_sample.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,16 +106,26 @@ def main():
106106
# 初始化变量
107107
service_id = None
108108

109-
# 查询服务列表
109+
# 拉取服务列表
110110
try:
111111
__logger.info('--------------------------------DescribeServices start...--------------------------------')
112-
response = aihc_client.service.DescribeServices()
112+
page_number = 1
113+
page_size = 2
114+
order_by = "createdAt"
115+
order = "asc"
116+
response = aihc_client.service.DescribeServices(
117+
pageNumber=page_number,
118+
pageSize=page_size,
119+
orderBy=order_by,
120+
order=order
121+
)
113122
print(json.dumps(to_dict(response), ensure_ascii=False))
114123
__logger.info('DescribeServices: %s', response.__dict__.keys())
115124

116125
# 获取第一个服务ID用于后续操作
117126
if hasattr(response, 'services') and response.services is not None and len(response.services) > 0:
118127
service_id = response.services[0].id
128+
print("service_id: %s" % service_id)
119129

120130
except BceHttpClientError as e:
121131
if isinstance(e.last_error, BceServerError):

0 commit comments

Comments
 (0)