Retrieves the details of a specified service.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
computenest: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. |
service-0e6fca6a51a544xxxxxx |
| ServiceVersion |
string |
No |
The service version. |
1.0 |
| ShowDetails |
array |
No |
Specifies whether to return the detailed information of the service. |
|
|
string |
No |
Specifies whether to return the detailed information of the service. |
ServiceInstanceRoleInfo |
|
| ServiceName |
string |
No |
The service name. |
Wordpress社区版 |
| ServiceInstanceId |
string |
No |
The service instance ID. |
si-b58c874912fc4294**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Status |
string |
The status of the service. Valid values:
|
Online |
| DeployMetadata |
string |
The deployment configuration of the service. The configuration is stored as a JSON string. The data format of the string varies based on the deployment type. |
{\"TemplateUrl\": \"http://tidbRosFile\"} |
| PublishTime |
string |
The time when the service was published. |
2021-05-21T00:00:00Z |
| RequestId |
string |
The request ID. |
06BF8F22-02DC-4750-83DF-3FFC11C065EA |
| Version |
string |
The service version. |
1.0 |
| DeployType |
string |
The deployment type. Valid values:
|
ros |
| ServiceId |
string |
The service ID. |
service-0e6fca6a51a544xxxxxx |
| SupplierUrl |
string |
The URL of the service provider. |
http://example.com |
| ServiceType |
string |
The service type. Valid values:
|
private |
| ServiceProductUrl |
string |
The URL of the product page. |
http://example1.com |
| 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-98f356602462.png |
| Name |
string |
The service name. |
B数据库 |
| ShortDescription |
string |
The summary of the service. |
B是A公司自主设计并研发的开源分布式的关系型数据库 |
| Agreements |
array<object> |
The service agreements. |
|
|
object |
The service agreements. |
||
| Name |
string |
The agreement name. |
用户协议 |
| Url |
string |
The agreement URL. |
https://url |
| Softwares |
array<object> |
The service software. |
|
|
object |
The service software. |
||
| Name |
string |
The software name. |
wordpress |
| Version |
string |
The software version. |
6.0.1 |
| IsSupportOperated |
boolean |
Specifies whether to enable Alibaba Cloud Managed Services. Default value: false. Valid values:
Note
This parameter is required when ServiceType is set to private. |
false |
| PolicyNames |
string |
The policy names. A single policy name can be up to 128 characters in length. Separate multiple names with 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 |
| ShareType |
string |
The share type. Valid values:
|
Public |
| Permission |
string |
The permission type. Valid values:
|
Deployable |
| AlarmMetadata |
string |
The alert configuration of the service. Note
This configuration takes effect only if you configure an alert policy in PolicyNames. |
{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] } |
| VersionName |
string |
The version name. |
v1 |
| 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 in days. The maximum trial duration is 30 days. |
7 |
| SupplierDesc |
string |
The description of the service provider. |
阿里云计算巢团队 |
| 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 O&M configuration. |
{\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}} |
| LogMetadata |
string |
The application log configuration. |
{\"Logstores\":[]} |
| SupplierLogo |
string |
The icon of the service provider. |
https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png |
| DeployFrom |
string |
The deployment channel. Valid values:
|
Marketplace |
| Categories |
string |
The service category name. |
AI |
| SupplierUid |
integer |
The Alibaba Cloud account ID of the service provider. |
158927391332***** |
| Commodity |
object |
The commodity specifications. |
|
| Type |
string |
The type. Valid values: Marketplace: Alibaba Cloud Marketplace. Css: Lingxiao. |
Marketplace |
| ChargeType |
string |
The billing method. Valid values: PREPAY (default): subscription. POSTPAY: pay-as-you-go. |
POSTPAY |
| OrderTime |
object |
The order time. |
|
|
array |
The order time. |
||
| CommodityCode |
string |
The commodity code. |
cmjj00**** |
| Specifications |
array<object> |
The Alibaba Cloud Marketplace specification details. |
|
|
object |
The Alibaba Cloud Marketplace specification details. |
||
| 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. |
[1:Month] |
|
| MarketplaceMetadata |
object |
The Alibaba Cloud Marketplace metadata. |
|
| SpecificationMappings |
array<object> |
The mapping between commodity specifications and templates or packages. |
|
|
object |
The mapping between commodity specifications and templates or packages. |
||
| SpecificationCode |
string |
The specification code of the Alibaba Cloud Marketplace commodity. |
cmjj00**** |
| TemplateName |
string |
The template name. |
单机版 |
| SpecificationName |
string |
The package name. |
套餐一 |
| CssMetadata |
object |
The Lingxiao configuration metadata. |
|
| ComponentsMappings |
array<object> |
The billing item mappings. |
|
|
object |
The billing item mappings. |
||
| TemplateName |
string |
The template name. |
单机版 |
| Mappings |
object |
The mappings. |
|
|
string |
The mappings. |
{{DBInstanceStorage}} |
|
| SaasBoostMetadata |
string |
The SaasBoost configuration metadata. |
{ "Enabled":false //公网交互地址 "PublicAccessUrl":"https://example.com" } |
| DeployPage |
string |
The deployment page. |
Order: 下单页 Detail: 详情页 |
| InstanceRoleInfos |
array<object> |
The information about the roles that are created in the service template. |
|
|
object |
|||
| TemplateName |
string |
The template name. |
模板1 |
| RoleName |
string |
The role name. |
ram-for-dts |
| PolicyDocument |
string |
The content of the control policy. |
{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Principal\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n} |
| Principals |
array |
The information about the RAM entity. |
|
|
string |
The information about the RAM entity. |
[{'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}, {'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}] |
|
| ServiceDocumentInfos |
array<object> |
The service documents. |
|
|
object |
The service documents. |
||
| Locale |
string |
The language of the service document. Valid values:
|
zh-CN |
| TemplateName |
string |
The template name. |
单机版 |
| DocumentUrl |
string |
The document URL. |
https://www.alibabacloud.com/help/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2 |
| 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@example.com |
| ComplianceMetadata |
object |
The compliance package metadata. |
|
| CompliancePacks |
array |
The list of compliance packages. |
|
|
string |
The compliance package. |
VpcDataRisk |
|
| ServiceLocaleConfigs |
array<object> |
The multilingual configurations of the service. |
|
|
object |
The multilingual configurations of the service. |
||
| OriginalValue |
string |
The raw data value of the service information. |
Service Name |
| ZhValue |
string |
The Chinese value of the service information. |
服务名称 |
| EnValue |
string |
The English value of the service information. |
Service Name |
Examples
Success response
JSON format
{
"Status": "Online",
"DeployMetadata": "{\\\"TemplateUrl\\\": \\\"http://tidbRosFile\\\"}",
"PublishTime": "2021-05-21T00:00:00Z",
"RequestId": "06BF8F22-02DC-4750-83DF-3FFC11C065EA",
"Version": "1.0",
"DeployType": "ros",
"ServiceId": "service-0e6fca6a51a544xxxxxx",
"SupplierUrl": "http://example.com",
"ServiceType": "private",
"ServiceProductUrl": "http://example1.com",
"SupplierName": "A公司",
"ServiceInfos": [
{
"Locale": "zh-CN",
"Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
"Name": "B数据库",
"ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库",
"Agreements": [
{
"Name": "用户协议",
"Url": "https://url"
}
],
"Softwares": [
{
"Name": "wordpress",
"Version": "6.0.1"
}
]
}
],
"IsSupportOperated": false,
"PolicyNames": "policyName1, policyName2",
"Duration": 259200,
"ShareType": "Public",
"Permission": "Deployable",
"AlarmMetadata": "{ \"TemplateUrl\": \"http://template.file.url\", // 应用分组级别告警元数据 \"ApplicationGroups\": [ { \"Name\": \"applicationGroup1\", \"TemplateUrl\": \"url1\" }, { \"Name\": \"applicationGroup2\", \"TemplateUrl\": \"url2\" } ] }",
"VersionName": "v1",
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"TrialDuration": 7,
"SupplierDesc": "阿里云计算巢团队",
"TrialType": "Trial",
"TenantType": "SingleTenant",
"LicenseMetadata": "{\\\"PayType\\\":\\\"CustomFixTime\\\",\\\"DefaultLicenseDays\\\":7,\\\"CustomMetadata\\\":[{\\\"TemplateName\\\":\\\"模板1\\\",\\\"SpecificationName\\\":\\\"bandwith-0\\\",\\\"CustomData\\\":\\\"1\\\"}]}",
"OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"New_Vpc_Ack_And_Jumpserver\\\":{}}}",
"LogMetadata": "{\\\"Logstores\\\":[]}",
"SupplierLogo": "https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png",
"DeployFrom": "Marketplace",
"Categories": "AI",
"SupplierUid": 0,
"Commodity": {
"Type": "Marketplace",
"ChargeType": "POSTPAY",
"OrderTime": {
"key": [
"[1:Month]"
]
},
"CommodityCode": "cmjj00****",
"Specifications": [
{
"Code": "cmjj00****\n",
"Name": "specifications1\n",
"Times": [
"[1:Month]"
]
}
],
"MarketplaceMetadata": {
"SpecificationMappings": [
{
"SpecificationCode": "cmjj00****",
"TemplateName": "单机版",
"SpecificationName": "套餐一"
}
]
},
"CssMetadata": {
"ComponentsMappings": [
{
"TemplateName": "单机版",
"Mappings": {
"key": "{{DBInstanceStorage}}\n"
}
}
]
},
"SaasBoostMetadata": "{\n \"Enabled\":false\n //公网交互地址\n \"PublicAccessUrl\":\"https://example.com\"\n}",
"DeployPage": "Order: 下单页\nDetail: 详情页"
},
"InstanceRoleInfos": [
{
"TemplateName": "模板1",
"RoleName": "ram-for-dts",
"PolicyDocument": "{\\n \\\"Version\\\": \\\"1\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": \\\"*\\\",\\n \\\"Principal\\\": \\\"*\\\",\\n \\\"Resource\\\": \\\"*\\\"\\n }\\n ]\\n}",
"Principals": [
"[{'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}, {'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}]"
]
}
],
"ServiceDocumentInfos": [
{
"Locale": "zh-CN",
"TemplateName": "单机版",
"DocumentUrl": "https://www.alibabacloud.com/help/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2"
}
],
"SupportContacts": [
{
"Type": "Email\n",
"Value": "supplier@example.com"
}
],
"ComplianceMetadata": {
"CompliancePacks": [
"VpcDataRisk"
]
},
"ServiceLocaleConfigs": [
{
"OriginalValue": "Service Name",
"ZhValue": "服务名称",
"EnValue": "Service Name"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.