获取服务开通状态、服务角色等预置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
computenest:GetServiceProvisions |
get |
*Service
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| ServiceId |
string |
是 |
服务 ID。 |
service-0efc0db451794bxxxxxx |
| ServiceVersion |
string |
否 |
服务版本。 |
1 |
| TemplateName |
string |
否 |
模板名称。 |
模板一 |
| TrialType |
string |
否 |
使用类型。可选值:
|
Trial |
| Parameters |
object |
否 |
用户实例部署的参数。 |
{\"RegionId\":\"cn-hangzhou\",\"ZoneId\":\"cn-hangzhou-g\",\"EcsInstanceType\":\"ecs.g5.large\",\"InstancePassword\":\"xxxxxxxx\",\"PayType\":\"PostPaid\",\"PayPeriodUnit\":\"Month\",\"PayPeriod\":1} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
8C27145F-C9F4-545D-A355-DCDDAD63D548 |
| ServiceProvisions |
array<object> |
服务详情。 |
|
|
array<object> |
服务详情。 |
||
| ServiceName |
string |
服务名称。 |
CS |
| Status |
string |
服务开通状态。可能值:
|
Enabled |
| AutoEnableService |
boolean |
是否在模板中定义了自动开通服务。取值:
|
true |
| RoleProvision |
object |
服务角色信息。若为空表示没有服务角色。 |
|
| Roles |
array<object> |
服务角色列表。 |
|
|
array<object> |
服务角色列表。 |
||
| RoleName |
string |
角色名称。 |
AliyunCSManagedVKRole |
| Created |
boolean |
角色是否已创建。取值:
|
true |
| Function |
string |
角色用途。 默认值:Default,表示该角色为服务默认角色。 |
Default |
| ApiForCreation |
object |
创建角色用到的 API 信息。 |
|
| ApiName |
string |
API 名称。 |
CreateServiceLinkedRole |
| ApiProductId |
string |
API 所属产品 ID。 |
rds |
| ApiType |
string |
API 类型。 取值:
|
Open |
| parameters |
object |
API 参数信息。${变量名}表示动态参数。 |
{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" } |
| AuthorizationURL |
string |
服务云资源访问授权链接。 若角色未创建,会返回此链接。 |
https://ram.console.aliyun.com/role/authorization?request={"Services":[{"Service":"CS","Roles":[{"RoleName":"AliyunCSManagedVKRole","TemplateId":"AliyunCSManagedVKRole"},{"RoleName":"AliyunCSDefaultRole","TemplateId":"Default"}]}],"ReturnUrl":"https://cs.console.aliyun.com/"} |
| StatusReason |
string |
云服务未开通或开通状态未知的原因。 说明
当 Status 取值为 Disabled 或 Unknown 时,返回该参数。 |
No permission |
| EnableURL |
string |
云服务开通链接。 说明
当 Status 取值为 Disabled 时,返回该参数。 |
https://common-buy.aliyun.com/?commodityCode=sls |
| CommodityProvisions |
array<object> |
商品详情。部分服务(如 ACS)会涉及多个商品的开通。 |
|
|
object |
商品详情。部分服务(如 ACS)会涉及多个商品的开通。 |
||
| CommodityCode |
string |
商品码。 |
acs_postpaid_public_cn |
| Status |
string |
云服务开通状态。可能的值:
|
Disabled |
| EnableURL |
string |
商品开通链接。 |
https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn |
示例
正常返回示例
JSON格式
{
"RequestId": "8C27145F-C9F4-545D-A355-DCDDAD63D548",
"ServiceProvisions": [
{
"ServiceName": "CS",
"Status": "Enabled",
"AutoEnableService": true,
"RoleProvision": {
"Roles": [
{
"RoleName": "AliyunCSManagedVKRole",
"Created": true,
"Function": "Default",
"ApiForCreation": {
"ApiName": "CreateServiceLinkedRole",
"ApiProductId": "rds",
"ApiType": "Open",
"parameters": {
"ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs",
"RegionId": "${RegionId}"
}
}
}
],
"AuthorizationURL": "https://ram.console.aliyun.com/role/authorization?request={\"Services\":[{\"Service\":\"CS\",\"Roles\":[{\"RoleName\":\"AliyunCSManagedVKRole\",\"TemplateId\":\"AliyunCSManagedVKRole\"},{\"RoleName\":\"AliyunCSDefaultRole\",\"TemplateId\":\"Default\"}]}],\"ReturnUrl\":\"https://cs.console.aliyun.com/\"}"
},
"StatusReason": "No permission",
"EnableURL": "https://common-buy.aliyun.com/?commodityCode=sls",
"CommodityProvisions": [
{
"CommodityCode": "acs_postpaid_public_cn",
"Status": "Disabled",
"EnableURL": "https://common-buy.aliyun.com/?commodityCode=acs_postpaid_public_cn"
}
]
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。