查询指定服务的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
computenest:GetService | get | *Service acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
ServiceId | string | 是 | 服务 ID。 | service-0e6fca6a51a544xxxxxx |
ServiceVersion | string | 是 | 服务版本。 | 1.0 |
ShowDetails | array | 否 | 是否透出服务详细信息。 | |
string | 否 | 是否透出服务详细信息。 | ServiceInstanceRoleInfo | |
ServiceName | string | 否 | 服务名称。 | Wordpress社区版 |
ServiceInstanceId | string | 否 | 服务实例 ID。 | si-b58c874912fc4294**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-12-27 | OpenAPI 返回结构发生变更 | 查看变更详情 |