批量授权API(专享版)
功能介绍
APP创建成功后,还不能访问API,如果想要访问某个API,需要将该API授权给APP。API主动授权成功后,在有效期内,APP即可访问该API。API授权包含授权和续约两部分功能。
-
授权:授权会给予APP在有效期内访问API的权利。
-
续约:续约会更新授权有效期,仅支持延长有效期,不能减少。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/authorize
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
api_id |
是 |
String |
API编号。 |
instance_id |
是 |
String |
集群ID编号。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
Dlm-Type |
否 |
String |
数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。 |
Content-Type |
是 |
String |
消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
time |
否 |
String |
截止时间。 |
app_ids |
否 |
Array of strings |
APP编号列表。 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
授权/续约ID为51159105c7838353d2834181d978af50集群上ID为760715eb1bfce0c575abab3be3bd41e6的API。
/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances/51159105c7838353d2834181d978af50/authorize { "app_ids" : [ "efa895e32e758bd316726b196ca1e8de" ], "time" : "2022-03-25T10:00:00.000Z" }
响应示例
无
SDK代码示例
SDK代码示例如下。
授权/续约ID为51159105c7838353d2834181d978af50集群上ID为760715eb1bfce0c575abab3be3bd41e6的API。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; import java.util.List; import java.util.ArrayList; public class AuthorizeApiToInstanceSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); AuthorizeApiToInstanceRequest request = new AuthorizeApiToInstanceRequest(); request.withApiId("{api_id}"); request.withInstanceId("{instance_id}"); ApiParaForAuthorizeToInstance body = new ApiParaForAuthorizeToInstance(); List<String> listbodyAppIds = new ArrayList<>(); listbodyAppIds.add("efa895e32e758bd316726b196ca1e8de"); body.withAppIds(listbodyAppIds); body.withTime("2022-03-25T10:00:00.000Z"); request.withBody(body); try { AuthorizeApiToInstanceResponse response = client.authorizeApiToInstance(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
授权/续约ID为51159105c7838353d2834181d978af50集群上ID为760715eb1bfce0c575abab3be3bd41e6的API。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = AuthorizeApiToInstanceRequest() request.api_id = "{api_id}" request.instance_id = "{instance_id}" listAppIdsbody = [ "efa895e32e758bd316726b196ca1e8de" ] request.body = ApiParaForAuthorizeToInstance( app_ids=listAppIdsbody, time="2022-03-25T10:00:00.000Z" ) response = client.authorize_api_to_instance(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
授权/续约ID为51159105c7838353d2834181d978af50集群上ID为760715eb1bfce0c575abab3be3bd41e6的API。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AuthorizeApiToInstanceRequest{} request.ApiId = "{api_id}" request.InstanceId = "{instance_id}" var listAppIdsbody = []string{ "efa895e32e758bd316726b196ca1e8de", } timeApiParaForAuthorizeToInstance:= "2022-03-25T10:00:00.000Z" request.Body = &model.ApiParaForAuthorizeToInstance{ AppIds: &listAppIdsbody, Time: &timeApiParaForAuthorizeToInstance, } response, err := client.AuthorizeApiToInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
204 |
操作API成功。 |
400 |
BadRequest。 |