Help Center> RES> API Reference> APIs (Old Version)> Online Service-related APIs> Subscribing to Services
View PDF

Subscribing to Services

Function

This API is used to subscribe to services to be shared.

URI

POST /v1/{project_id}/infer-services/{service_id}/share

Table 1 describes the URI parameters.

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

service_name

Yes

String

Service name

description

No

String

Service description

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

Yes

Boolean

Whether the request is successful

message

Yes

String

Response message

Example

  • Example request 
    {  
     "service_name": "res-subscribe2",
     "description": "test subscribe service"
}
  • Example of a successful response 
    {  
    "is_success": true,  
    "message": "Succeed to subcribe service." 
}
  • Example of a failed response 
    {  
    "is_success": false,  
    "error_code": "res.2301",  
    "error_msg": "Failed to resolve the token from the request."  
}

Status Code

For details about status codes, see Status Codes.