GetService-阿里云帮助中心

Retrieves the details of a service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:GetService

*All Resource

*

None

Request syntax

GET /api/v1/services/{ServiceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ServiceId	string	No	The service ID.	1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID. You can call the ListInstances operation to obtain the instance ID.	pairec-test-xxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D75C43DC-3D3A-5CC8-9AAC-8C77306C433B
Name	string	The service name.	test_rec
Description	string	The service description.	this is a test rec engine
Region	string	The region where the service is deployed.	cn-beijing
EngineConfigId	string	The engine configuration ID.	3
CrInstanceId	string		cri-xxx
RepositoryId	string		crr-xxx
ImageName	string	The image name.	registry-vpc.cn-beijing.aliyuncs.com/*/*
ImageAuth	string	The image secret.	********
ServiceResourceUri	string	The resource address used to publish the service, such as the resource group name in Elastic Algorithm Service (EAS).	eas-resource-xxx
ServiceConfig	string	The configuration used to publish the service, such as the service configuration in EAS.	{"Port":8080}
GmtReleasedTime	string	The time of the most recent production release.	2021-12-15T23:24:33.132+08:00
LatestProdReleaseOrder	object	The most recent production release record.
ReleaseOrderId	string	The release order ID.	3
Topic	string	The release title.	update version
Content	string	The release content.	update golang version to 1.22
ImageVersion	string	The image version.	2.0.0
Releaser	string	The publisher, including the name and UID of the Resource Access Management (RAM) users.	E-xxx.xxx-@xxx.onaliyun.com
ReleaseInfo	string	The release information.	{ "Pre": { "Status": "Released", "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00", }, "Prod": { "Status": "Released", "GmtReleasedTime" : "2021-12-15T23:24:33.132+08:00", } }

Examples

Success response

JSON format

{
  "RequestId": "D75C43DC-3D3A-5CC8-9AAC-8C77306C433B",
  "Name": "test_rec",
  "Description": "this is a test rec engine",
  "Region": "cn-beijing",
  "EngineConfigId": "3",
  "ImageName": "registry-vpc.cn-beijing.aliyuncs.com/***/***",
  "ImageAuth": "********",
  "ServiceResourceUri": "eas-resource-xxx",
  "ServiceConfig": "{\"Port\":8080}",
  "GmtReleasedTime": "2021-12-15T23:24:33.132+08:00",
  "LatestProdReleaseOrder": {
    "ReleaseOrderId": "3",
    "Topic": "update version",
    "Content": "update golang version to 1.22",
    "ImageVersion": "2.0.0",
    "Releaser": "E-xxx.xxx-@xxx.onaliyun.com",
    "ReleaseInfo": "{\n\t\"Pre\": {\n    \"Status\": \"Released\",\n    \"GmtReleasedTime\" : \"2021-12-15T23:24:33.132+08:00\",\n  },\n  \"Prod\": {\n    \"Status\": \"Released\",\n    \"GmtReleasedTime\" : \"2021-12-15T23:24:33.132+08:00\",\n  }\n}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.