调用GetService查询指定服务的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
computenestsupplier:GetService | get | *Service acs:computenestsupplier:{#regionId}:{#accountId}:service/{#ServiceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
ServiceId | string | 是 | 服务 ID。 您可以通过调用ListServices - 查询服务信息获取服务 ID。 | service-f8469d2d14eb40af**** |
ServiceVersion | string | 否 | 服务版本。 您可以通过调用ListServices - 查询服务信息获取服务版本。 | 1 |
ShowDetail | array | 否 | 返回详细信息。 | |
string | 否 | 返回详细信息。 取值:ServiceStatistic,服务统计信息。 | ServiceStatistic | |
FilterAliUid | boolean | 否 | 是否要过滤 AliUid。 取值:
| false |
SharedAccountType | string | 否 | 服务共享类型。 取值:
| SharedAccount |
返回参数
示例
正常返回示例
JSON
格式
{
"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": "",
"Version": ""
}
]
}
],
"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\"}",
"ComplianceMetadata": {
"CompliancePacks": [
""
]
},
"ServiceDocumentInfos": [
{
"Locale": "",
"TemplateName": "",
"DocumentUrl": ""
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-10-25 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-10-25 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-10-22 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-27 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-10 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-04-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-03-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-03-22 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-02-23 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-02-22 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-23 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-14 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-24 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-11 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |