All Products
Search
Document Center

Platform For AI:DescribeService

Last Updated:Nov 22, 2024

Queries the details about a service.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eas:DescribeServiceget
*Service
acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}
    none
none

Request syntax

GET /api/v2/services/{ClusterId}/{ServiceName} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the region where the service is deployed.

cn-shanghai
ServiceNamestringYes

The service name. For more information about how to query the service name, see ListServices .

foo

Response parameters

ParameterTypeDescriptionExample
Service

The details about the service.

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82********",
  "Region": "cn-shanghai",
  "CallerUid": "20123*******",
  "ParentUid": "11234*******",
  "CurrentVersion": 1,
  "Cpu": 1,
  "Gpu": 0,
  "Image": "registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320",
  "PendingInstance": 0,
  "RunningInstance": 1,
  "TotalInstance": 1,
  "InternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo",
  "IntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo",
  "LatestVersion": 1,
  "Memory": 1024,
  "Message": "Service start successfully",
  "Namespace": "echo",
  "Reason": "RUNNING",
  "Resource": "eas-r-xxxxxxx",
  "ResourceAlias": "my_resource",
  "ServiceConfig": "{        \"metadata\": {             \"cpu\":1,             \"instance\":1,             \"memory\":1024           },         \"name\":\"echo\",         \"processor_entry\":\"libecho.so\",         \"processor_path\":\"http://oss-cn-hangzhou-zmf.aliyuncs.com/059247/echo_processor_release.tar.gz\",         \"processor_type\":\"cpp\"     }",
  "ServiceName": "echo",
  "ServiceGroup": "my_group",
  "Status": "Running",
  "CreateTime": "2021-01-29T11:13:20Z",
  "UpdateTime": "2021-01-29T11:13:20Z",
  "Weight": 100,
  "ServiceId": "eas-m-xxasdat",
  "ServiceUid": "eas-m-xxasdat\n",
  "AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
  "Source": "dsw",
  "ExtraData": "{\\\"blue_green_services\\\":[\\\"test\\\",\\\"testxxxx\\\"]}",
  "Role": "Queue",
  "RoleAttrs": "\"{\\\"ApproxMaxLength\\\":null,\\\"Length\\\":null,\\\"MaxPayloadBytes\\\":null}\"",
  "SafetyLock": "dangerous",
  "SecondaryInternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
  "SecondaryIntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
  "Labels": [
    {
      "LabelKey": "key1",
      "LabelValue": "value1"
    }
  ],
  "WorkspaceId": "123445",
  "AppType": "LLM",
  "AppConfig": "{\"ModelStorage\":\"oss\"}",
  "AppSpecName": "llama_7b_fp16",
  "AppVersion": "v1"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history