Help Center/ DataArts Studio/ API Reference/ DataArts DataService APIs/ API Management/ Batch Authorization API (Exclusive Edition)
Updated on 2024-11-06 GMT+08:00

Batch Authorization API (Exclusive Edition)

Function

An app cannot access any APIs after being created. To enable an app to access an API, authorize the API to the app. After the authorization is successful, the app can access the API within the validity period.

API authorization includes authorization and renewal.

  • Authorization: Apps are granted the right to access APIs within the validity period.

  • Renewal: The validity period of the authorization is updated during renewal. The validity period can be extended but cannot be reduced.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/authorize

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

api_id

Yes

String

API ID

instance_id

Yes

String

Cluster ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

Dlm-Type

No

String

Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.

Content-Type

Yes

String

Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

time

No

String

End time.

app_ids

No

Array of strings

App IDs

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Authorize or renew the API whose ID is 760715eb1bfce0c575abab3be3bd41e6 in the cluster whose ID is 51159105c7838353d2834181d978af50.

/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances/51159105c7838353d2834181d978af50/authorize

{
  "app_ids" : [ "efa895e32e758bd316726b196ca1e8de" ],
  "time" : "2022-03-25T10:00:00.000Z"
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Authorize or renew the API whose ID is 760715eb1bfce0c575abab3be3bd41e6 in the cluster whose ID is 51159105c7838353d2834181d978af50.

 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());
        }
    }
}

Authorize or renew the API whose ID is 760715eb1bfce0c575abab3be3bd41e6 in the cluster whose ID is 51159105c7838353d2834181d978af50.

 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)

Authorize or renew the API whose ID is 760715eb1bfce0c575abab3be3bd41e6 in the cluster whose ID is 51159105c7838353d2834181d978af50.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

204

The API operation is successful.

400

Bad request