GetServiceProvisions - 获取服务开通状态和服务角色等预置信息

获取服务开通状态、服务角色等预置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenest:GetServiceProvisionsget
*Service
acs:computenest:{#regionId}:{#accountId}:service/{#serviceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ServiceIdstring

服务 ID。

service-0efc0db451794bxxxxxx
ServiceVersionstring

服务版本。

1
TemplateNamestring

模板名称。

模板一
TrialTypestring

使用类型。可选值:

  • Trial:支持试用。

  • NotTrial:不支持试用。

Trial
Parametersobject

用户实例部署的参数。

{\"RegionId\":\"cn-hangzhou\",\"ZoneId\":\"cn-hangzhou-g\",\"EcsInstanceType\":\"ecs.g5.large\",\"InstancePassword\":\"xxxxxxxx\",\"PayType\":\"PostPaid\",\"PayPeriodUnit\":\"Month\",\"PayPeriod\":1}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

8C27145F-C9F4-545D-A355-DCDDAD63D548
ServiceProvisionsarray<object>

服务详情。

serviceProvisionsobject

服务详情。

ServiceNamestring

服务名称。

CS
Statusstring

服务开通状态。可能值:

  • Enabled:已开通。

  • EnabledByDefault:默认开通。

  • Disabled:未开通。

  • Unknown:未知。

Enabled
AutoEnableServiceboolean

是否在模板中定义了自动开通服务。取值:

  • true:自动开通。

  • false:手动开通。

true
RoleProvisionobject

服务角色信息。若为空表示没有服务角色。

Rolesarray<object>

服务角色列表。

rolesobject

服务角色列表。

RoleNamestring

角色名称。

AliyunCSManagedVKRole
Createdboolean

角色是否已创建。取值:

  • true:已创建。

  • false:未创建。

true
Functionstring

角色用途。 默认值:Default,表示该角色为服务默认角色。

Default
ApiForCreationobject

创建角色用到的 API 信息。

ApiNamestring

API 名称。

CreateServiceLinkedRole
ApiProductIdstring

API 所属产品 ID。

rds
ApiTypestring

API 类型。 取值:

  • Open:开放 API。

  • Inner:内部 API。

Open
parametersobject

API 参数信息。${变量名}表示动态参数。

{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" }
AuthorizationURLstring

服务云资源访问授权链接。 若角色未创建,会返回此链接。

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/"}
StatusReasonstring

云服务未开通或开通状态未知的原因。

说明 当 Status 取值为 Disabled 或 Unknown 时,返回该参数。
No permission
EnableURLstring

云服务开通链接。

说明 当 Status 取值为 Disabled 时,返回该参数。
https://common-buy.aliyun.com/?commodityCode=sls

示例

正常返回示例

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"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史