调用GetServiceProvisions接口查询服务开通状态和服务角色信息。

使用说明

本文将提供一个示例,在杭州地域使用模板{"ROSTemplateFormatVersion": "2015-09-01","Resources": {"ApiGateway": {"Type": "ALIYUN::ApiGateway::Group","Properties": { "GroupName": "ros_example" }},"FC": {"Type": "ALIYUN::FC::Service","Properties": {"ServiceName": "ros_example"}}}}查询API网关和函数计算的开通状态及服务角色信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetServiceProvisions

要执行的操作,取值:GetServiceProvisions。

RegionId String cn-hangzhou

地域ID。

您可以调用DescribeRegions查看最新的阿里云地域列表。

TemplateBody String {"ROSTemplateFormatVersion": "2015-09-01","Resources": {"ApiGateway": {"Type": "ALIYUN::ApiGateway::Group","Properties": { "GroupName": "ros_example" }},"FC": {"Type": "ALIYUN::FC::Service","Properties": {"ServiceName": "ros_example"}}}}

模板主体的结构。长度为1~524,288个字节。如果长度较大,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免因URL过长而导致请求失败。

您必须且仅能指定TemplateBody、TemplateURL、TemplateId或Services其中一个参数。

TemplateURL String oss://ros-template/demo

包含模板主体的文件的位置。URL必须指向位于HTTP Web服务器(HTTP或HTTPS)或阿里云OSS存储空间中的模板(1~524,288个字节)。OSS存储空间的URL,例如oss://ros/template/demo或oss://ros/template/demo?RegionId=cn-hangzhou。如未指定OSS地域,默认与接口参数RegionId相同。

您必须且仅能指定TemplateBody、TemplateURL、TemplateId或Services其中一个参数。

TemplateId String 5ecd1e10-b0e9-4389-a565-e4c15efc****

模板ID。支持共享模板和私有模板。

您必须且仅能指定TemplateBody、TemplateURL、TemplateId或Services其中一个参数。

TemplateVersion String v1

模板版本。如果不指定,默认取最新版本。

TemplateVersion仅在指定TemplateId时生效。

Parameters.N.ParameterKey String Amount

参数的名称。如果未指定参数的名称和值,则ROS将使用模板中指定的默认值。

说明 Parameters为可选参数。若指定了Parameters,则ParameterKey为必选参数。
Parameters.N.ParameterValue String 12

参数的值。

说明 Parameters为可选参数。若指定了Parameters,则ParameterValue为必选参数。
Services.N.ServiceName String FC

云服务名称。取值:

  • AHAS:应用高可用服务。
  • ARMS:应用实时监控服务。
  • ApiGateway:API网关。
  • BatchCompute:批量计算。
  • BrainIndustrial:工业大脑。
  • CloudStorageGateway:云存储网关。
  • CMS:云监控。
  • CR:镜像容器服务。
  • CS:容器服务。
  • DCDN:全站加速。
  • DataHub:数据总线。
  • DataWorks:数据工场。
  • EDAS:企业级分布式应用服务。
  • EMAS:移动研发平台。
  • FC:函数计算。
  • FNF:Serverless工作流。
  • MaxCompute:大数据计算服务。
  • MNS:消息服务。
  • HBR:混合云备份。
  • IMM:智能媒体管理。
  • IOT:物联网平台。
  • KMS:密钥管理服务。
  • NAS:文件存储。
  • NLP:自然语言处理。
  • OSS:对象存储服务。
  • OTS:表格存储。
  • PrivateLink:私网连接。
  • PrivateZone:云解析。
  • RocketMQ:消息队列RocketMQ版。
  • SAE:应用引擎。
  • SLS:日志服务。
  • TrafficMirror:流量镜像。
  • VS:视频监控。
  • Xtrace:链路追踪。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
RequestId String D7A7F4B1-219A-1965-9D54-765254420E22

请求ID。

ServiceProvisions Array of ServiceProvision

云服务详情。

ServiceName String FC

云服务名称。

Status String Enabled

云服务开通状态。取值:

  • Enabled:已开通。
  • Disabled:未开通。
  • Unknown:开通状态未知。
StatusReason String No permission.

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

说明 当Status取值为Disabled或Unknown时,返回该参数。
AutoEnableService Boolean false

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

  • true:自动开通。
  • false:手动开通。
EnableURL String https://common-buy.aliyun.com/?commodityCode=fc

云服务开通链接。

说明 当Status取值为Disabled时,返回该参数。
RoleProvision Object

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

Roles Array of Role

云服务角色列表。

RoleName String AliyunFcDefaultRole

角色名称。

Created Boolean false

角色是否已创建。取值:

  • true:已创建。
  • false:未创建。
Function String Default

角色用途。

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

AuthorizationURL String https://ram.console.aliyun.com/role/commonAuthorize?request={\"RoleName\": \"AliyunFcDefaultRole\", \"ReturnUrl\": \"https://fc.console.aliyun.com/\", \"Service\": \"FC\", \"SystemPolicyArray\": [\"AliyunFCDefaultRolePolicy\"], \"RoleDescription\": \"Default Service Role for FC to operate other resource\"}

角色授权链接。

说明 当Created取值为false时,返回该参数。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=GetServiceProvisions
&RegionId=cn-hangzhou
&TemplateBody={"ROSTemplateFormatVersion": "2015-09-01","Resources": {"ApiGateway": {"Type": "ALIYUN::ApiGateway::Group","Properties": { "GroupName": "ros_example" }},"FC": {"Type": "ALIYUN::FC::Service","Properties": {"ServiceName": "ros_example"}}}}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetServiceProvisionsResponse>
    <RequestId>D7A7F4B1-219A-1965-9D54-765254420E22</RequestId>
    <ServiceProvisions>
        <Status>Enabled</Status>
        <ServiceName>ApiGateway</ServiceName>
        <RoleProvision>
        </RoleProvision>
        <AutoEnableService>false</AutoEnableService>
    </ServiceProvisions>
    <ServiceProvisions>
        <Status>Enabled</Status>
        <ServiceName>FC</ServiceName>
        <RoleProvision>
            <AuthorizationURL>https://ram.console.aliyun.com/role/commonAuthorize?request={"RoleName": "AliyunFcDefaultRole", "ReturnUrl": "https://fc.console.aliyun.com/", "Service": "FC", "SystemPolicyArray": ["AliyunFCDefaultRolePolicy"], "RoleDescription": "Default Service Role for FC to operate other resource"}</AuthorizationURL>
            <Roles>
                <Function>Default</Function>
                <RoleName>AliyunFcDefaultRole</RoleName>
                <Created>false</Created>
            </Roles>
        </RoleProvision>
        <AutoEnableService>false</AutoEnableService>
    </ServiceProvisions>
</GetServiceProvisionsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D7A7F4B1-219A-1965-9D54-765254420E22",
  "ServiceProvisions" : [ {
    "Status" : "Enabled",
    "ServiceName" : "ApiGateway",
    "RoleProvision" : {
      "Roles" : [ ]
    },
    "AutoEnableService" : false
  }, {
    "Status" : "Enabled",
    "ServiceName" : "FC",
    "RoleProvision" : {
      "AuthorizationURL" : "https://ram.console.aliyun.com/role/commonAuthorize?request={\"RoleName\": \"AliyunFcDefaultRole\", \"ReturnUrl\": \"https://fc.console.aliyun.com/\", \"Service\": \"FC\", \"SystemPolicyArray\": [\"AliyunFCDefaultRolePolicy\"], \"RoleDescription\": \"Default Service Role for FC to operate other resource\"}",
      "Roles" : [ {
        "Function" : "Default",
        "RoleName" : "AliyunFcDefaultRole",
        "Created" : false
      } ]
    },
    "AutoEnableService" : false
  } ]
}

错误码

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