Obtaining Service Event Logs
Function
This API is used to obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer. Obtain its CLI example hcloud ModelArts ShowServiceEvents.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
modelarts:service:getEvents
Read
service *
g:ResourceTag/<tag-key>
-
-
URI
GET /v1/{project_id}/services/{service_id}/events
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID and Name. |
|
service_id |
Yes |
String |
Service ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
event_type |
No |
String |
Event type. Enums:
|
|
event_info |
No |
String |
Event information. Only English information can be filtered. The following special characters are not supported: `(){}';,[]<>/? |
|
start_time |
No |
Number |
Start time for filtering events. By default, events are not filtered. |
|
end_time |
No |
Number |
End time for filtering events. By default, events are not filtered. |
|
offset |
No |
Integer |
Start page for pagination display. The default value is 0. |
|
limit |
No |
Integer |
Maximum number of records returned on each page. Default value: 1000 |
|
sort_by |
No |
String |
Specifies the sorting field. The default value is occur_time (event generation time). |
|
order |
No |
String |
Sorting order. Enums:
|
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
service_name |
String |
Service name |
|
total_count |
Integer |
Total number of events that meet the search criteria when no paging is performed |
|
service_id |
String |
Service ID |
|
count |
Integer |
Number of events in the query result |
|
events |
Array of Events objects |
Event logs of a service |
|
Parameter |
Type |
Description |
|---|---|---|
|
event_type |
String |
Event type. Options:
|
|
event_info |
String |
Event information, which mainly describes the the five phases of the deployment process. More information can be supplemented later. The five phases are image building, environment preparation, resource scheduling, image pulling, and model startup. |
|
occur_time |
Number |
Time when an event occurs, in milliseconds calculated from 1970.1.1 0:0:0 UTC. |
Example Requests
GET https://{endpoint}/v1/{project_id}/services/{service_id}/events
Example Responses
Status code: 200
Event logs of a service
{
"service_name" : "service-07085",
"total_count" : 9,
"service_id" : "35de3ca9-1bca-4ae7-9cb0-914f30fa7d3e",
"count" : 9,
"events" : [ {
"event_type" : "normal",
"event_info" : "start to deploy service",
"occur_time" : 1562597251764
}, {
"event_type" : "normal",
"event_info" : "building image for model [TF 3.0.0]",
"occur_time" : 1562597251788
}, {
"event_type" : "normal",
"event_info" : "model (TF 3.0.0) build image success",
"occur_time" : 1562597251805
}, {
"event_type" : "normal",
"event_info" : "preparing environment",
"occur_time" : 1562597255744
}, {
"event_type" : "normal",
"event_info" : "[TF 3.0.0] prepare environment success",
"occur_time" : 1562597275915
}, {
"event_type" : "normal",
"event_info" : "[TF 3.0.0] schedule resource success",
"occur_time" : 1562597275921
}, {
"event_type" : "normal",
"event_info" : "[TF 3.0.0] pulling model image",
"occur_time" : 1562597275928
}, {
"event_type" : "normal",
"event_info" : "[TF 3.0.0] pull image success",
"occur_time" : 1562597332570
}, {
"event_type" : "normal",
"event_info" : "[TF 3.0.0] starting model",
"occur_time" : 1562597332582
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Event logs of a service |
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