Call DBS OpenAPI by using the Alibaba Cloud CLI - Data Management

Alibaba Cloud CLI ile Data Disaster Recovery'nin yönetim ve bakım işlemlerini komut satırından otomatikleştirebilirsiniz. Bu eğitimi tamamladıktan sonra şunları yapabilirsiniz:

RAM kullanıcısı kimlik bilgileriyle Alibaba Cloud CLI'yi yükleyip yapılandırın
Kullanılabilir Data Disaster Recovery API işlemlerini keşfedin
Bir API işlemini çağırın ve yanıtı yorumlayın

Bu eğitimde örnek olarak DescribeBackupPlanBilling kullanılmaktadır.

Ön koşullar

Başlamadan önce aşağıdakilere sahip olduğunuzdan emin olun:

Bir Alibaba Cloud hesabı
AliyunDMSFullAccess ilkesi eklenmiş bir RAM kullanıcısı — bkz. RAM kullanıcısına izin verme
RAM kullanıcısı için bir AccessKey çifti — bkz. AccessKey çifti oluşturma

Önemli

Alibaba Cloud hesabı, tüm Alibaba Cloud hizmetlerine tam erişime sahiptir. En az ayrıcalık ilkesine uyarak yalnızca gerekli izinleri verecek şekilde bir Resource Access Management (RAM) kullanıcısı oluşturun. Data Disaster Recovery tarafından desteklenen izin ilkeleri için bkz. Önceden tanımlanmış sistem ilkeleri ve Özel ilkeler.

1. Adım: Alibaba Cloud CLI'yı yükleme

Ortamınıza uygun yolu seçin.

Seçenek A: Cloud Shell kullanma (yüklemeye gerek yok)

Alibaba Cloud CLI, Cloud Shell'de önceden yüklü gelir. Cloud Shell ayrıca bir kimlik bilgisini otomatik olarak yapılandırdığından 2. Adımı atlayıp doğrudan 3. Adıma geçebilirsiniz. Bkz. Cloud Shell nedir?

Seçenek B: Yerel makineye yükleme

Alibaba Cloud CLI Windows, Linux ve macOS'u destekler. İşletim sisteminiz için kılavuzu izleyin:

Alibaba Cloud CLI hakkında genel bilgi edinmek için bkz. Alibaba Cloud CLI nedir?

2. Adım: Kimlik bilgilerini yapılandırma

Not

Cloud Shell kullanıyorsanız bu adımı atlayın; kimlik bilgileri otomatik olarak yapılandırılır.

Alibaba Cloud CLI'da AccessKey kimlik bilgilerinizi bir AkProfile yapılandırması kullanarak ayarlayın:

Bir RAM kullanıcısı oluşturun ve bu kullanıcı için bir AccessKey çifti oluşturun.
AliyunDMSFullAccess ilkesini RAM kullanıcısına ekleyin. Bkz. RAM kullanıcısına izin verme.
Kullanmak istediğiniz bölgenin bölge kimliğini bulun. Alibaba Cloud CLI, API isteklerini belirttiğiniz bölgeye gönderir. Data Disaster Recovery'nin desteklediği bölgeler için bkz. Uç noktalar.
AccessKey kimlik bilgilerini AkProfile yapılandırma dosyasında ayarlayın. Adım adım örnek için bkz. Kimlik bilgilerini yapılandırma konusundaki "Yapılandırma örnekleri" bölümü.

Alibaba Cloud CLI birden çok kimlik bilgisi türünü destekler. Tam liste için bkz. Kimlik bilgilerini yapılandırma konusundaki "Kimlik bilgisi türleri" bölümü.

Not

Herhangi bir komut için belirli bir bölgeyi hedeflemek üzere --region seçeneğini kullanın. Bu seçenek, kimlik bilgisi yapılandırmanızda ve ortam değişkenlerinde ayarlanan bölgeyi geçersiz kılar. Bkz. API çağrıları için komut satırı seçenekleri.

3. Adım: CLI komutu oluşturma

OpenAPI Explorer, her Data Disaster Recovery API işlemi için kullanıma hazır CLI komutları oluşturur.

OpenAPI Explorer'da DescribeBackupPlanBilling açın.
Parameters sekmesinde istek parametrelerini girin.
Oluşturulan komutu görüntülemek için CLI Example sekmesini tıklayın.
Komutu kopyalayın veya çalıştırın:
- Komutu Cloud Shell'de doğrudan çalıştırmak için simgesini tıklayın.
- Komudu panoya kopyalamak ve yerel kabuğunuza yapıştırmak için simgesini tıklayın.

Not

OpenAPI Explorer, oluşturulan komutlara varsayılan olarak --region ekler. Komutu yerel olarak çalıştırdığınızda Alibaba Cloud CLI, kimlik bilgisi yapılandırmanızdaki bölge yerine bu bölgeyi kullanır. İhtiyaçlarınıza göre seçeneği kaldırın veya koruyun. Parametre biçimi ayrıntıları için bkz. Parametre biçimleri.

4. Adım: API işlemlerini çağırma

Alibaba Cloud CLI, varsayılan olarak 2019-03-06 sürümündeki Data Disaster Recovery API işlemlerini entegre eder. 2021-01-01 sürümü işlemlerini çağırmak için --force ve --version seçeneklerini kullanın. OpenAPI Explorer, 2021-01-01 API'si için bir komut oluşturduğunuzda bu seçenekleri otomatik olarak ekler.

Birden çok komutu zincirleyen karmaşık iş akışlarında verimliliği artırmak için bunları bir kabuk betiğinde derleyin.

İşlemlerin tam listesi için bkz:

Kullanılabilir API işlemlerini listeleme

Alibaba Cloud CLI'da kullanılabilen tüm 2019-03-06 API işlemlerini görmek için --help seçeneğini kullanın:

aliyun dbs --help

Beklenen çıktı:

Yedekleme planı faturalandırma bilgilerini sorgulama

Aşağıdaki örnek, bir yedekleme planı için faturalandırma bilgilerini sorgulamak üzere DescribeBackupPlanBilling işlemini çağırır. Tam parametre referansı için bkz. DescribeBackupPlanBilling.

aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true

Beklenen çıktı:

{
  "HttpStatusCode": 200,
  "RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
  "Success": true,
  "Item": {
    "BuyCreateTimestamp": 1658372830000,
    "FullStorageSize": 151,
    "BuyExpiredTimestamp": 1661097600000,
    "BuySpec": "micro",
    "QuotaEndTimestamp": 1659283200000,
    "IsExpired": true,
    "QuotaStartTimestamp": 1656604800000,
    "TotalFreeBytes": 858993459200,
    "PaiedBytes": 0,
    "UsedFullBytes": 0,
    "IsFreeBytesUnlimited": true,
    "ContStorageSize": 10437039,
    "BuyChargeType": "PREPAY",
    "UsedIncrementBytes": 9406734
  }
}

Hataları giderme

Bir API çağrısı hata döndürürse hata kodunu kontrol edin ve istek parametrelerinin ile değerlerinin geçerli olduğunu doğrulayın.

Kendi kendine teşhis için OpenAPI Sorun Giderme adresini ziyaret edin ve yanıttaki istek kimliğini veya SDK hata bilgilerini girin.

Sonraki adımlar

API referansı (2019-03-06) ve API referansı (2021-01-01) içindeki tüm kullanılabilir işlemleri keşfedin
2021-01-01 işlemlerini çağırmak için --force ve --version kullanın — bkz. Bir API işlemini zorla çağırma