查询OS的配额
功能介绍
查询OS配额接口用于获取ModelArts OS服务中部分资源的配额信息,如资源池配额、网络配额等。该接口适用于以下场景:当需要了解资源池或网络资源的使用限制、规划资源分配或监控资源使用情况时,用户可通过此接口获取相关配额信息。使用该接口的前提条件是ModelArts OS服务已部署且用户具有相应的权限(如管理员权限或资源管理权限)。调用接口成功后,系统将返回资源池配额、网络配额等详细信息,帮助用户更好地进行资源规划和管理。若用户无权限访问该接口、服务不可用或配额信息未配置,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quotas |
Quota object |
参数解释: 资源配额。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释:资源类型 取值范围:可选值如下:
|
|
quota |
String |
参数解释: 资源配额上限。 取值范围: 不涉及。 |
|
used |
String |
参数解释: 已使用配额。 取值范围: 不涉及。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
|
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
无
响应示例
状态码:200
OK。
{
"quotas" : {
"resources" : [ {
"type" : "pool",
"quota" : 15,
"used" : 10
}, {
"type" : "network",
"quota" : 15,
"used" : 10
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
404 |
Not Found。 |
错误码
请参见错误码。