通过地域ID、服务实例iD或者云市场实例ID、查询服务实例的详细信息，例如服务状态、模板名称、资源列表等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| computenest:GetServiceInstance | get | *ServiceInstance acs:computenest:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ServiceInstanceId | string | 否 | 服务实例 ID。 说明
输入参数时， ServiceInstanceId或MarketInstanceId其中一个参数必须填写，否则将无法查询服务实例的详细信息。
| si-d6ab3a63ccbb4b17**** |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| MarketInstanceId | string | 否 | 云市场实例 ID。 | 704***59 |
返回参数
示例
正常返回示例
JSON格式
{
"Outputs": "{\"InstanceIds\":[\"i-hp38ofxl0dsyfi7z****\"]}",
"Status": "Deployed",
"TemplateName": "模板1",
"UpdateTime": "2021-05-20T00:00:00Z",
"Progress": 90,
"Parameters": "{\"param\":\"value\"}",
"RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
"ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
"CreateTime": "2021-05-20T00:00:00Z",
"StatusDetail": "deploy successfully",
"Resources": "[{\"StackId\": \"stack-xxx\"}]",
"Service": {
"Status": "Online",
"PublishTime": "2021-05-21T00:00:00Z",
"Version": "1",
"DeployMetadata": "{\"EstimateTime\":null,\"SupplierDeployMetadata\":{\"DeployTimeout\":null},\"TemplateConfigs\":[{\"Name\":\"模板1\",\"Url\":\"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\",\"PredefinedParameters\":[],\"AllowedRegions\":[\"cn-hangzhou\"]}]}",
"DeployType": "ros",
"ServiceId": "service-9c8a3522528b4fe8****",
"SupplierUrl": "http://example.com",
"ServiceType": "private",
"SupplierName": "A公司",
"ServiceInfos": [
{
"Locale": "zh-CN",
"Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
"Name": "B数据库",
"ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库"
}
],
"VersionName": "版本A",
"UpgradeMetadata": "{\n \"Type\": \"OOS\",\n \"Description\": \"Changelog or something description\",\n \"SupportUpgradeFromVersions\": [1, 2],\n \"UpgradeSteps\": {\n \"PreUpgradeStage\": {\n \"Description\": \"初始化数据库\",\n \"Type\": \"RunCommand\",\n \"ResourceName\": \"EcsRole1\",\n \"CommandType\": \"runShellScript\",\n \"CommandContent\": \"echo hello\"\n },\n \"UpgradeStage\": [{\n \"Description\": \"更新EcsRole1实例\",\n \"Type\": \"RunCommand\",\n \"ResourceName\": \"EcsRole1\",\n \"ArtifactsDownloadDirectory\": \"/home/admin\",\n \"CommandType\": \"runShellScript\",\n \"CommandContent\": \"echo hello\"\n }],\n \"PostUpgradeStage\": {\n \"Description\": \"部署后post check\",\n \"Type\": \"None/RunCommand\",\n \"ResourceName\": \"EcsRole1\",\n \"CommandType\": \"runShellScript\",\n \"CommandContent\": \"echo hello\"\n }\n }\n}",
"UpgradableServiceVersions": [
"1"
],
"UpgradableServiceInfos": [
{
"Version": "draft",
"VersionName": "20241112"
}
],
"ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
"ServiceDocUrl": "http://example.com"
},
"OperationStartTime": "2021-12-29T06:48:56Z",
"OperationEndTime": "2022-01-28T06:48:56Z",
"OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
"EnableInstanceOps": true,
"IsOperated": true,
"NetworkConfig": {
"EndpointId": "ep-m5ei37240541816b****",
"PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
"PrivateVpcConnections": [
{
"EndpointId": "ep-m5ei37240541816b****",
"PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
"PrivateZoneName": "test.computenest.aliyuncs.com",
"ConnectionConfigs": [
{
"VpcId": "vpc-bp1vwnn14rqpyiczj****",
"SecurityGroups": [
"'sg-m5ec4mvoq9egn7xxxxxx"
],
"VSwitches": [
"vsw-uf6iqwohr05dw4mxxxxxx"
],
"IngressEndpointStatus": "Ready",
"NetworkServiceStatus": "Ready",
"EndpointIps": [
"192.xxx.xxx.xxx"
],
"DomainName": "ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com",
"RegionId": "cn-beijing",
"ConnectBandwidth": 0
}
],
"RegionId": "cn-hangzhou"
}
],
"ReversePrivateVpcConnections": [
{
"EndpointId": "ep-m5ei42370541816b****"
}
]
},
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"LicenseEndTime": "2022-01-01T12:00:00",
"UserId": 0,
"SupplierUid": 0,
"EndTime": "2022-01-01T12:00:00",
"Source": "User",
"ServiceType": "private",
"PayType": "Subscription",
"Name": "TestName",
"EnableUserPrometheus": true,
"Components": "{\"TiKVServerCount\":\"3\",\"package_version\":\"yuncode5398300001\",\"PDServerCount\":\"3\",\"TiDBServerCount\":\"2\"}",
"PredefinedParameterName": "套餐一",
"MarketInstanceId": "704***59",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"BizStatus": "Normal",
"GrafanaDashBoardUrl": "https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-03-01 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-25 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-12 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-04-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-04-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-23 | OpenAPI 描述信息更新 | 查看变更详情 |
| 2022-06-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |