Retrieves the details of a specified service.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
computenestsupplier:GetService |
get |
*Service
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. |
cn-hangzhou |
| ServiceId |
string |
No |
The service ID. Call the ListServices operation to obtain the service ID. |
service-f8469d2d14eb40af**** |
| ServiceVersion |
string |
No |
The service version. Call the ListServices operation to obtain the service version. |
1 |
| ShowDetail |
array |
No |
The details to be returned. |
|
|
string |
No |
The details to be returned. Valid value: ServiceStatistic. This value indicates the statistics information of the service. |
ServiceStatistic |
|
| FilterAliUid |
boolean |
No |
Specifies whether to filter the results by Alibaba Cloud account ID. Valid values:
|
false |
| SharedAccountType |
string |
No |
The service sharing type. Valid values:
|
SharedAccount |
| ServiceInstanceId |
string |
No |
The service instance ID. |
si-56eb5823dxxxx |
| ServiceName |
string |
No |
The service name. |
Wordpress社区版 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Status |
string |
The service status. Valid values:
|
Online |
| DeployMetadata |
string |
The information about the service deployment configuration. The information varies based on the deployment type. Different deployment types use different data formats. Therefore, the information is stored as a JSON string. |
{\"TemplateConfigs\":[{\"Name\":\"模板1\",\"Url\":\"oss://computenest-test/template" + ".json?RegionId=cn-beijing\",\"PredefinedParameters\":[{\"Name\":\"低配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":40}},{\"Name\":\"高配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":200}}]}]} |
| PublishTime |
string |
The time when the service was published. |
2021-05-21T00:00:00Z |
| RequestId |
string |
The request ID. |
9AC8E73E-88DE-52C2-A29B-531FC13A5604 |
| Version |
string |
The service version. |
1.0 |
| DeployType |
string |
The deployment type. Valid values:
|
ros |
| ServiceId |
string |
The service ID. |
service-ca83ff3cb6b14dbc**** |
| SupplierUrl |
string |
The URL of the service provider. |
http://example.com |
| ServiceProductUrl |
string |
The URL of the product page. |
http://example2.com |
| ServiceType |
string |
The service type. Valid values:
|
private |
| SupplierName |
string |
The name of the service provider. |
A公司 |
| ServiceInfos |
array<object> |
The service information. |
|
|
object |
The service information. |
||
| Locale |
string |
The language of the service configuration. Valid values:
|
zh-CN |
| Image |
string |
The URL of the service icon. |
https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f35660****.png |
| Name |
string |
The service name. |
B数据库 |
| ShortDescription |
string |
The summary of the service. |
B是A公司自主设计并研发的开源分布式的关系型数据库 |
| LongDescriptionUrl |
string |
The URL of the detailed description of the service. |
https://example.com |
| Agreements |
array<object> |
The information about the service agreement. |
|
|
object |
The information about the service agreement. |
||
| Name |
string |
The agreement name. |
Name |
| Url |
string |
The URL of the agreement. |
https://aliyun.com/xxxxxxxx.html |
| Softwares |
array<object> |
The information about the software used in the service. |
|
|
object |
The information about the software used in the service. |
||
| Name |
string |
The software name. |
MySQL |
| Version |
string |
The software version. |
5.7 |
| IsSupportOperated |
boolean |
Indicates whether Alibaba Cloud Managed Services is enabled. Valid values:
|
false |
| PolicyNames |
string |
The policy names. A policy name can be up to 128 characters in length. Multiple policy names are separated by commas (,). Only policies related to Alibaba Cloud Managed Services are supported. |
policyName1, policyName2 |
| Duration |
integer |
The duration of the Alibaba Cloud Managed Services. Unit: seconds. |
259200 |
| Progress |
integer |
The deployment progress of the service instance. Unit: %. |
90 |
| StatusDetail |
string |
The description of the service status. |
deploy successfully |
| CreateTime |
string |
The time when the service was created. |
2021-05-20T00:00:00Z |
| UpdateTime |
string |
The time when the service was last updated. |
2021-05-22T00:00:00Z |
| ShareType |
string |
The sharing type. Valid values:
|
Public |
| AlarmMetadata |
string |
The alert configurations of the service. |
{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] } |
| UpgradeMetadata |
string |
The upgrade metadata. |
{\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]} |
| VersionName |
string |
The version name. |
v1 |
| PayFromType |
string |
The payment source. Valid values:
|
None |
| Tags |
array<object> |
The service tags. |
|
|
object |
The service tags. |
||
| Key |
string |
The tag key. |
key1 |
| Value |
string |
The tag value. |
value1 |
| TrialDuration |
integer |
The trial duration. Unit: days. |
7 |
| TrialType |
string |
The trial type. Valid values:
|
Trial |
| TenantType |
string |
The tenant type. Valid values:
|
SingleTenant |
| LicenseMetadata |
string |
The license metadata. |
{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]} |
| OperationMetadata |
string |
The configurations of Alibaba Cloud Managed Services. |
{\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}} |
| TestStatus |
string |
The test status. Valid values:
|
SERVICE_TEST_SUCCEED |
| ApprovalType |
string |
The approval type of the service usage application. Valid values:
|
Manual |
| RegistrationId |
string |
The registration ID. |
sr-1b4aabc1c9eb4109**** |
| ResourceGroupId |
string |
The resource group ID. |
rg-acfm2jfvb7b**** |
| Permission |
string |
The permission type. Valid values:
|
Deployable |
| Statistic |
object |
The statistics information. |
|
| AccumulativeInstanceCount |
integer |
The total number of service instances. This includes deleted instances. |
75 |
| AccumulativeUserCount |
integer |
The total number of users. This includes historical users. |
60 |
| DeployedServiceInstanceCount |
integer |
The number of online service instances. This indicates the number of service instances that are successfully deployed. |
20 |
| DeployedUserCount |
integer |
The number of online users. This indicates the number of users who have successfully deployed service instances. |
10 |
| SubmittedUsageCount |
integer |
The number of service applications that are in the Submitted state. |
10 |
| AccumulativePocAmount |
number |
The total consumption amount of the trial service. Unit: CNY. |
80.35 |
| AveragePocAmount |
number |
The average consumption amount of a trial service instance. Unit: CNY. |
40.17 |
| AveragePocUnitAmount |
number |
The average consumption amount of a trial service instance per unit of time. Unit: CNY. |
167.9 |
| AveragePocDuration |
number |
The average trial duration of a service instance. Unit: hours. |
1 |
| SourceServiceId |
string |
The ID of the source service for distribution. |
service-70a3b15bb6264315**** |
| SourceServiceVersion |
string |
The version of the source service for distribution. |
1 |
| SourceSupplierName |
string |
The name of the service provider of the source service for distribution. |
SourceSupplier |
| LogMetadata |
string |
The application log configurations. |
{ "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置 "FilePattern": "access.log*" # 对容器不需要,在YAML中配置 } ] } |
| Resellable |
boolean |
Indicates whether the service can be distributed. Valid values:
|
false |
| VirtualInternetService |
string |
Indicates whether the service is a virtual Internet service. Valid values:
|
false |
| ServiceDiscoverable |
string |
Indicates whether the service is discoverable. Valid values:
|
DISCOVERABLE |
| Categories |
string |
The service category. |
DevOps |
| ShareTypeStatus |
string |
The sharing status of the service. Important This parameter is deprecated. |
该参数已弃用。 |
| ServiceAuditDocumentUrl |
string |
The URL of the service review file. |
https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx |
| EntitySource |
object |
The source of the reported data. |
|
|
string |
The source of the reported data. Valid values:
|
ComputNest |
|
| CrossRegionConnectionStatus |
string |
The binding relationship of the commodity module. |
componesConfigs |
| VirtualInternetServiceId |
string |
The virtual Internet service ID. |
service-70a3b15bb6264345**** |
| Commodity |
object |
The commodity specifications. |
|
| Type |
string |
The type. Valid values:
|
Marketplace |
| ChargeType |
string |
The billing method. Valid values:
|
PREPAY |
| Components |
array |
The commodity modules. |
|
|
string |
The commodity modules. |
YARN |
|
| Specifications |
array<object> |
The details of the Alibaba Cloud Marketplace specifications. |
|
|
object |
The details of the Alibaba Cloud Marketplace specifications. |
||
| Code |
string |
The commodity code. |
cmjj00**** |
| Name |
string |
The specification name. |
specifications1 |
| Times |
array |
The purchasable duration. Unit: week or year. |
|
|
string |
The purchasable duration. Unit: week or year. |
3 |
|
| MeteringEntities |
array<object> |
The metering information. |
|
|
object |
The metering information. |
||
| EntityId |
string |
The metering item ID. |
cmgj5682****-NetworkOut |
| Name |
string |
The name of the metering item property. |
spring-boot-demo |
| MarketplaceMetadata |
object |
The metadata of Alibaba Cloud Marketplace. |
|
| SpecificationMappings |
array<object> |
The relationship between commodity specifications and templates or packages. |
|
|
object |
The relationship between commodity specifications and templates or packages. |
||
| SpecificationCode |
string |
The commodity specification code of Alibaba Cloud Marketplace. |
cmjj00**** |
| TemplateName |
string |
The template name. |
模板1 |
| SpecificationName |
string |
The package name. |
按量付费 |
| TrialType |
string |
The trial type. Valid values:
|
NotTrial |
| MeteringEntityMappings |
array<object> |
The binding relationship between the package and the metering dimension. |
|
|
object |
The binding relationship between the package and the metering dimension. |
||
| EntityIds |
string |
The metering item ID. |
cmgj1596****-NetworkOut-2 |
| TemplateName |
string |
The template name. |
模板1 |
| SpecificationName |
string |
The package name. |
按量付费套餐 |
| MeteringEntityExtraInfos |
array<object> |
The configuration information of the metering item. |
|
|
object |
The configuration information of the metering item. |
||
| EntityId |
string |
The metering item ID. |
cmgj1596****-NetworkOut-2 |
| Type |
string |
The metering metric. |
AvgPod |
| MetricName |
string |
The name of the metering metric. |
NetworkLantency |
| Promql |
string |
The custom Prometheus statement. |
avg_over_time(count(kube_pod_info{namespace=\"default\"})[1h:1m]) |
| CssMetadata |
object |
The configuration metadata of Lingxiao. |
|
| ComponentsMappings |
array<object> |
The billing item mapping. |
|
|
object |
The billing item mapping. |
||
| Mappings |
object |
The mapping. |
|
|
string |
The mapping. |
{{DBInstanceStorage}} |
|
| TemplateName |
string |
The template name. |
模板1 |
| MeteringEntityMappings |
array<object> |
The binding relationship between the package and the metering dimension. |
|
|
object |
The binding relationship between the package and the metering dimension. |
||
| EntityIds |
string |
The metering item ID. |
cmgj0015****-Frequency-1 |
| TemplateName |
string |
The template name. |
模板1 |
| SpecificationName |
string |
The package name. |
按量付费套餐 |
| MeteringEntityExtraInfos |
array<object> |
The configuration information of the metering item. |
|
|
object |
The configuration information of the metering item. |
||
| EntityId |
string |
The metering item ID. |
cmgj0048****-Frequency-1 |
| Type |
string |
The metering metric. |
ComputeNestPrometheus |
| MetricName |
string |
The metric name. |
AvgMemory |
| Promql |
string |
The custom Prometheus statement. |
avg_over_time(count(kube_pod_info{namespace=\"default\"})[1h:1m]) |
| CommodityCode |
string |
The commodity code of Alibaba Cloud Marketplace. |
cmjj00xxxx |
| SaasBoostMetadata |
string |
The configuration metadata of SaaS Boost. |
{ "Enabled":false //公网交互地址 "PublicAccessUrl":"https://example.com" } |
| BuildInfo |
string |
The information about the build service. |
{ "RepoUrl": "https://github.com/user/repo.git", "Brancn": "main"} |
| BuildParameters |
string |
The parameters of the build service. |
{ "ServiceTemplateId": "st-xxxxx"} |
| ComplianceMetadata |
object |
The compliance check metadata. |
|
| CompliancePacks |
array |
The selected compliance package. |
|
|
string |
The selected compliance package. |
VpcDataRisk: VPC内数据安全风险合规包。 |
|
| ServiceDocumentInfos |
array<object> |
The service document information. |
|
|
object |
The service document information. |
||
| Locale |
string |
The language of the service configuration. Valid values:
|
zh-CN |
| TemplateName |
string |
The template name. |
模板1 |
| DocumentUrl |
string |
The URL of the document. |
http://doc.com |
| SupportContacts |
array<object> |
The contact information of the service provider. |
|
|
object |
The contact information of the service provider. |
||
| Type |
string |
The type of the contact information. |
|
| Value |
string |
The contact information. |
supplier@test.com |
| SecretKey |
string |
The service key. It is used for digital signature encryption. |
6cfc5d4649c54216**** |
| ServiceLocaleConfigs |
array<object> |
The multi-language configurations of the service. |
|
|
object |
The multi-language configurations of the service. |
||
| OriginalValue |
string |
The original value of the business information. |
Service Name |
| ZhValue |
string |
The Chinese value of the business information. |
服务名称 |
| EnValue |
string |
The English value of the business information. |
Service Name |
Examples
Success response
JSON format
{
"Status": "Online",
"DeployMetadata": "{\\\"TemplateConfigs\\\":[{\\\"Name\\\":\\\"模板1\\\",\\\"Url\\\":\\\"oss://computenest-test/template\" \n + \".json?RegionId=cn-beijing\\\",\\\"PredefinedParameters\\\":[{\\\"Name\\\":\\\"低配版\\\",\" \n + \"\\\"Parameters\\\":{\\\"InstanceType\\\":\\\"ecs.g5.large\\\",\\\"DataDiskSize\\\":40}},{\\\"Name\\\":\\\"高配版\\\",\" \n + \"\\\"Parameters\\\":{\\\"InstanceType\\\":\\\"ecs.g5.large\\\",\\\"DataDiskSize\\\":200}}]}]}",
"PublishTime": "2021-05-21T00:00:00Z",
"RequestId": "9AC8E73E-88DE-52C2-A29B-531FC13A5604",
"Version": "1.0",
"DeployType": "ros",
"ServiceId": "service-ca83ff3cb6b14dbc****",
"SupplierUrl": "http://example.com",
"ServiceProductUrl": "http://example2.com",
"ServiceType": "private",
"SupplierName": "A公司",
"ServiceInfos": [
{
"Locale": "zh-CN",
"Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f35660****.png",
"Name": "B数据库",
"ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库",
"LongDescriptionUrl": "https://example.com",
"Agreements": [
{
"Name": "Name",
"Url": "https://aliyun.com/xxxxxxxx.html"
}
],
"Softwares": [
{
"Name": "MySQL",
"Version": "5.7"
}
]
}
],
"IsSupportOperated": false,
"PolicyNames": "policyName1, policyName2",
"Duration": 259200,
"Progress": 90,
"StatusDetail": "deploy successfully",
"CreateTime": "2021-05-20T00:00:00Z",
"UpdateTime": "2021-05-22T00:00:00Z",
"ShareType": "Public",
"AlarmMetadata": "{\n \"TemplateUrl\": \"http://template.file.url\",\n // 应用分组级别告警元数据\n \"ApplicationGroups\": [\n {\n \"Name\": \"applicationGroup1\",\n \"TemplateUrl\": \"url1\"\n },\n {\n \"Name\": \"applicationGroup2\",\n \"TemplateUrl\": \"url2\"\n }\n ]\n}",
"UpgradeMetadata": "{\\\"SupportRollback\\\":true,\\\"SupportUpgradeFromVersions\\\":[],\\\"UpgradeComponents\\\":[\\\"Configuration\\\"]}",
"VersionName": "v1",
"PayFromType": "None",
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"TrialDuration": 7,
"TrialType": "Trial",
"TenantType": "SingleTenant",
"LicenseMetadata": "{\\\"PayType\\\":\\\"CustomFixTime\\\",\\\"DefaultLicenseDays\\\":7,\\\"CustomMetadata\\\":[{\\\"TemplateName\\\":\\\"模板1\\\",\\\"SpecificationName\\\":\\\"bandwith-0\\\",\\\"CustomData\\\":\\\"1\\\"}]}",
"OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"New_Vpc_Ack_And_Jumpserver\\\":{}}}",
"TestStatus": "SERVICE_TEST_SUCCEED",
"ApprovalType": "Manual",
"RegistrationId": "sr-1b4aabc1c9eb4109****",
"ResourceGroupId": "rg-acfm2jfvb7b****",
"Permission": "Deployable",
"Statistic": {
"AccumulativeInstanceCount": 75,
"AccumulativeUserCount": 60,
"DeployedServiceInstanceCount": 20,
"DeployedUserCount": 10,
"SubmittedUsageCount": 10,
"AccumulativePocAmount": 80.35,
"AveragePocAmount": 40.17,
"AveragePocUnitAmount": 167.9,
"AveragePocDuration": 1
},
"SourceServiceId": "service-70a3b15bb6264315****",
"SourceServiceVersion": "1",
"SourceSupplierName": "SourceSupplier",
"LogMetadata": "{\n \"Logstores\": [\n {\n \t\"LogstoreName\": \"access-log\",\n \t\t\"LogPath\": \"/home/admin/app/logs\", # 对容器不需要,在YAML中配置\n \t\t\"FilePattern\": \"access.log*\" # 对容器不需要,在YAML中配置\n }\n ]\n}",
"Resellable": false,
"VirtualInternetService": "false",
"ServiceDiscoverable": "DISCOVERABLE",
"Categories": "DevOps",
"ShareTypeStatus": "该参数已弃用。",
"ServiceAuditDocumentUrl": "https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx",
"EntitySource": {
"key": "ComputNest"
},
"CrossRegionConnectionStatus": "componesConfigs",
"VirtualInternetServiceId": "service-70a3b15bb6264345****",
"Commodity": {
"Type": "Marketplace",
"ChargeType": "PREPAY",
"Components": [
"YARN"
],
"Specifications": [
{
"Code": "cmjj00****",
"Name": "specifications1",
"Times": [
"3"
]
}
],
"MeteringEntities": [
{
"EntityId": "cmgj5682****-NetworkOut",
"Name": "spring-boot-demo"
}
],
"MarketplaceMetadata": {
"SpecificationMappings": [
{
"SpecificationCode": "cmjj00****",
"TemplateName": "模板1",
"SpecificationName": "按量付费",
"TrialType": "NotTrial"
}
],
"MeteringEntityMappings": [
{
"EntityIds": "cmgj1596****-NetworkOut-2",
"TemplateName": "模板1",
"SpecificationName": "按量付费套餐"
}
],
"MeteringEntityExtraInfos": [
{
"EntityId": "cmgj1596****-NetworkOut-2",
"Type": "AvgPod",
"MetricName": "NetworkLantency",
"Promql": "avg_over_time(count(kube_pod_info{namespace=\\\"default\\\"})[1h:1m])"
}
]
},
"CssMetadata": {
"ComponentsMappings": [
{
"Mappings": {
"key": "{{DBInstanceStorage}}"
},
"TemplateName": "模板1"
}
],
"MeteringEntityMappings": [
{
"EntityIds": "cmgj0015****-Frequency-1",
"TemplateName": "模板1",
"SpecificationName": "按量付费套餐"
}
],
"MeteringEntityExtraInfos": [
{
"EntityId": "cmgj0048****-Frequency-1",
"Type": "ComputeNestPrometheus",
"MetricName": "AvgMemory",
"Promql": "avg_over_time(count(kube_pod_info{namespace=\\\"default\\\"})[1h:1m])"
}
]
},
"CommodityCode": "cmjj00xxxx",
"SaasBoostMetadata": "{\n \"Enabled\":false\n //公网交互地址\n \"PublicAccessUrl\":\"https://example.com\"\n}"
},
"BuildInfo": "{ \"RepoUrl\": \"https://github.com/user/repo.git\", \"Brancn\": \"main\"}",
"BuildParameters": "{ \"ServiceTemplateId\": \"st-xxxxx\"}",
"ComplianceMetadata": {
"CompliancePacks": [
"VpcDataRisk: VPC内数据安全风险合规包。"
]
},
"ServiceDocumentInfos": [
{
"Locale": "zh-CN",
"TemplateName": "模板1",
"DocumentUrl": "http://doc.com"
}
],
"SupportContacts": [
{
"Type": "Email",
"Value": "supplier@test.com"
}
],
"SecretKey": "6cfc5d4649c54216****",
"ServiceLocaleConfigs": [
{
"OriginalValue": "Service Name\n",
"ZhValue": "服务名称",
"EnValue": "Service Name\n"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.